{"items":[{"type":"link","label":"Rolodex (Contacts & Organizations)","link":"/apis/rolodex/rolodex-v1","routeSlug":"/apis/rolodex/rolodex-v1","content":{"contentType":"overview","meta":{"name":"Rolodex (Contacts & Organizations)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"rolodex-v1.json","url":"/_bundle/apis/rolodex/rolodex-v1.json?download"},{"kind":"download","label":"rolodex-v1.yaml","url":"/_bundle/apis/rolodex/rolodex-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Rolodex (Contacts & Organizations) (v1-2025-04-18)","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":"The Contacts & Organizations, or Rolodex, app provides the Customer Relationship Management (CRM) capabilities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the Rhythm platform. Common integrations with the Rolodex API include finding or updating contact information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"demographics, or communication preferences for a Contact or Organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Like most of the other Rhythm apps, the Rolodex API includes endpoints for Query Definitions. These endpoints are commonly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used to retrieve saved queries, which can then be executed using the Query endpoints of the System API."},"children":[]}]}]}]}],"sectionId":"/apis/rolodex/rolodex-v1"}],"sectionId":"/apis/rolodex/rolodex-v1"}]}]}},{"type":"group","label":"Account Delegation Processes","link":"/apis/rolodex/rolodex-v1/account-delegation-processes","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes","items":[{"label":"Gets all of the account delegation processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/listaccountdelegationprocesses","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/listaccountdelegationprocesses","metadata":{"seo":{"title":"Gets all of the account delegation processes in the system.","description":"This method will scan all account delegation processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountDelegationProcesses","name":"Gets all of the account delegation processes in the system.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the account delegation processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all account delegation processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accountDelegationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}","href":"account-delegation-processes/listaccountdelegationprocesses","openApiOperationId":"listAccountDelegationProcesses","summary":"Gets all of the account delegation processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_592"}},"schemaId":"schema_592","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_592","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_592"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/listaccountdelegationprocesses"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}"},{"label":"Creates a new account delegation process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/createaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/createaccountdelegationprocess","metadata":{"seo":{"title":"Creates a new account delegation process record that does not already exist.","description":"This method will auto-generate an ID and create a new account delegation process. If an ID is specified for the account delegation process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountDelegationProcess","name":"Creates a new account delegation process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new account delegation process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new account delegation process. If an ID is specified for the account delegation process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/post/requestBody","description":"The account delegation process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accountDelegationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}","href":"account-delegation-processes/createaccountdelegationprocess","openApiOperationId":"createAccountDelegationProcess","summary":"Creates a new account delegation process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The account delegation process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The account delegation process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/createaccountdelegationprocess"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accountDelegationProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}/batch","href":"account-delegation-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The account delegation process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}/batch"},{"label":"Returns a account delegation process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/deleteaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/deleteaccountdelegationprocess","metadata":{"seo":{"title":"Returns a account delegation process from the system by its ID.","description":"This method will delete a account delegation process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountDelegationProcess","name":"Returns a account delegation process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a account delegation process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a account delegation process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the account delegation process to delete.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accountDelegationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}/{id}","href":"account-delegation-processes/deleteaccountdelegationprocess","openApiOperationId":"deleteAccountDelegationProcess","summary":"Returns a account delegation process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The account delegation process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The account delegation process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/deleteaccountdelegationprocess"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Returns a account delegation process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/getaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/getaccountdelegationprocess","metadata":{"seo":{"title":"Returns a account delegation process from the system by its ID.","description":"This method will look up a account delegation process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountDelegationProcess","name":"Returns a account delegation process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a account delegation process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a account delegation process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the account delegation process to return.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accountDelegationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}/{id}","href":"account-delegation-processes/getaccountdelegationprocess","openApiOperationId":"getAccountDelegationProcess","summary":"Returns a account delegation process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The account delegation process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/getaccountdelegationprocess"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Partially updates a account delegation process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/patchaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/patchaccountdelegationprocess","metadata":{"seo":{"title":"Partially updates a account delegation process with the specified ID.","description":"This method will patch an existing account delegation process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAccountDelegationProcess","name":"Partially updates a account delegation process with the specified ID.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a account delegation process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing account delegation process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the account delegation process to patch.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/accountDelegationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}/{id}","href":"account-delegation-processes/patchaccountdelegationprocess","openApiOperationId":"patchAccountDelegationProcess","summary":"Partially updates a account delegation process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The account delegation process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The account delegation process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/patchaccountdelegationprocess"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Updates a account delegation process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/updateaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/updateaccountdelegationprocess","metadata":{"seo":{"title":"Updates a account delegation process with the specified ID.","description":"This method will update an existing account delegation process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccountDelegationProcess","name":"Updates a account delegation process with the specified ID.","isWebhook":false,"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a account delegation process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing account delegation process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the account delegation process to update.","required":true}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated account delegation process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/accountDelegationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountDelegationProcesses/{tenantId}/{id}","href":"account-delegation-processes/updateaccountdelegationprocess","openApiOperationId":"updateAccountDelegationProcess","summary":"Updates a account delegation process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account delegation process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}},"schemaId":"components/schemas/AccountDelegationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The account delegation process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The account delegation process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The account delegation process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve account delegation process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1accountDelegationProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountDelegationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountDelegationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-delegation-processes/updateaccountdelegationprocess"}],"panels":[]}]},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Account Delegation Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Delegation Processes","showPageActions":true},{"nodeType":"markdoc","content":"Account Delegation Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accountDelegationProcesses/{tenantId}","summary":"Gets all of the account delegation processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-delegation-processes/listaccountdelegationprocesses","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}","summary":"Creates a new account delegation process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-delegation-processes/createaccountdelegationprocess","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-delegation-processes/executebatchoperations","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}/{id}","summary":"Returns a account delegation process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-delegation-processes/deleteaccountdelegationprocess","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}/{id}","summary":"Returns a account delegation process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-delegation-processes/getaccountdelegationprocess","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}/{id}","summary":"Partially updates a account delegation process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/account-delegation-processes/patchaccountdelegationprocess","deprecated":false},{"title":"/accountDelegationProcesses/{tenantId}/{id}","summary":"Updates a account delegation process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-delegation-processes/updateaccountdelegationprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Address Types","link":"/apis/rolodex/rolodex-v1/address-types","routeSlug":"/apis/rolodex/rolodex-v1/address-types","items":[{"label":"Gets all of the address types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/listaddresstypes","routeSlug":"/apis/rolodex/rolodex-v1/address-types/listaddresstypes","metadata":{"seo":{"title":"Gets all of the address types in the system.","description":"This method will scan all address types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAddressTypes","name":"Gets all of the address types in the system.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the address types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all address types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1addressTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addressTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addressTypes/{tenantId}","href":"address-types/listaddresstypes","openApiOperationId":"listAddressTypes","summary":"Gets all of the address types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_595"}},"schemaId":"schema_595","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_595","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_595"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/listaddresstypes"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}"},{"label":"Creates a new address type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/createaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/createaddresstype","metadata":{"seo":{"title":"Creates a new address type record that does not already exist.","description":"This method will auto-generate an ID and create a new address type. If an ID is specified for the address type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAddressType","name":"Creates a new address type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new address type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new address type. If an ID is specified for the address type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","pointer":"/paths/~1addressTypes~1{tenantId}/post/requestBody","description":"The address type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addressTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addressTypes/{tenantId}","href":"address-types/createaddresstype","openApiOperationId":"createAddressType","summary":"Creates a new address type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The address type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The address type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/createaddresstype"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/address-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1addressTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addressTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addressTypes/{tenantId}/batch","href":"address-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The address type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}/batch"},{"label":"Returns a address type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/deleteaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/deleteaddresstype","metadata":{"seo":{"title":"Returns a address type from the system by its ID.","description":"This method will delete a address type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAddressType","name":"Returns a address type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a address type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a address type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the address type to delete.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/addressTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addressTypes/{tenantId}/{id}","href":"address-types/deleteaddresstype","openApiOperationId":"deleteAddressType","summary":"Returns a address type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The address type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The address type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/deleteaddresstype"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Returns a address type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/getaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/getaddresstype","metadata":{"seo":{"title":"Returns a address type from the system by its ID.","description":"This method will look up a address type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAddressType","name":"Returns a address type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a address type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a address type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the address type to return.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addressTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addressTypes/{tenantId}/{id}","href":"address-types/getaddresstype","openApiOperationId":"getAddressType","summary":"Returns a address type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The address type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/getaddresstype"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Partially updates a address type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/patchaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/patchaddresstype","metadata":{"seo":{"title":"Partially updates a address type with the specified ID.","description":"This method will patch an existing address type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAddressType","name":"Partially updates a address type with the specified ID.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a address type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing address type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the address type to patch.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/addressTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addressTypes/{tenantId}/{id}","href":"address-types/patchaddresstype","openApiOperationId":"patchAddressType","summary":"Partially updates a address type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The address type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The address type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/patchaddresstype"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Updates a address type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/updateaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/updateaddresstype","metadata":{"seo":{"title":"Updates a address type with the specified ID.","description":"This method will update an existing address type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAddressType","name":"Updates a address type with the specified ID.","isWebhook":false,"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a address type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing address type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the address type to update.","required":true}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated address type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/addressTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addressTypes/{tenantId}/{id}","href":"address-types/updateaddresstype","openApiOperationId":"updateAddressType","summary":"Updates a address type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The address type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}},"schemaId":"components/schemas/AddressType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The address type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The address type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The address type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve address type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1addressTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address-types/updateaddresstype"}],"panels":[]}]},"httpPath":"/addressTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Address Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address Types","showPageActions":true},{"nodeType":"markdoc","content":"Address Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addressTypes/{tenantId}","summary":"Gets all of the address types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address-types/listaddresstypes","deprecated":false},{"title":"/addressTypes/{tenantId}","summary":"Creates a new address type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address-types/createaddresstype","deprecated":false},{"title":"/addressTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address-types/executebatchoperations","deprecated":false},{"title":"/addressTypes/{tenantId}/{id}","summary":"Returns a address type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/address-types/deleteaddresstype","deprecated":false},{"title":"/addressTypes/{tenantId}/{id}","summary":"Returns a address type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address-types/getaddresstype","deprecated":false},{"title":"/addressTypes/{tenantId}/{id}","summary":"Partially updates a address type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/address-types/patchaddresstype","deprecated":false},{"title":"/addressTypes/{tenantId}/{id}","summary":"Updates a address type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/address-types/updateaddresstype","deprecated":false}]}]}]}]}},{"type":"group","label":"Communication Types","link":"/apis/rolodex/rolodex-v1/communication-types","routeSlug":"/apis/rolodex/rolodex-v1/communication-types","items":[{"label":"Gets all of the communication types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/listcommunicationtypes","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/listcommunicationtypes","metadata":{"seo":{"title":"Gets all of the communication types in the system.","description":"This method will scan all communication types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCommunicationTypes","name":"Gets all of the communication types in the system.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the communication types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all communication types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1communicationTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicationTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/communicationTypes/{tenantId}","href":"communication-types/listcommunicationtypes","openApiOperationId":"listCommunicationTypes","summary":"Gets all of the communication types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}},"schemaId":"schema_596","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_596","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/listcommunicationtypes"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}"},{"label":"Creates a new communication type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/createcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/createcommunicationtype","metadata":{"seo":{"title":"Creates a new communication type record that does not already exist.","description":"This method will auto-generate an ID and create a new communication type. If an ID is specified for the communication type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCommunicationType","name":"Creates a new communication type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new communication type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new communication type. If an ID is specified for the communication type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","pointer":"/paths/~1communicationTypes~1{tenantId}/post/requestBody","description":"The communication type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicationTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/communicationTypes/{tenantId}","href":"communication-types/createcommunicationtype","openApiOperationId":"createCommunicationType","summary":"Creates a new communication type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The communication type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The communication type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/createcommunicationtype"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1communicationTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/communicationTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/communicationTypes/{tenantId}/batch","href":"communication-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The communication type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}/batch"},{"label":"Returns a communication type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/deletecommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/deletecommunicationtype","metadata":{"seo":{"title":"Returns a communication type from the system by its ID.","description":"This method will delete a communication type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCommunicationType","name":"Returns a communication type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a communication type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a communication type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the communication type to delete.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/communicationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/communicationTypes/{tenantId}/{id}","href":"communication-types/deletecommunicationtype","openApiOperationId":"deleteCommunicationType","summary":"Returns a communication type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The communication type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The communication type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/deletecommunicationtype"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Returns a communication type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/getcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/getcommunicationtype","metadata":{"seo":{"title":"Returns a communication type from the system by its ID.","description":"This method will look up a communication type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommunicationType","name":"Returns a communication type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a communication type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a communication type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the communication type to return.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/communicationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/communicationTypes/{tenantId}/{id}","href":"communication-types/getcommunicationtype","openApiOperationId":"getCommunicationType","summary":"Returns a communication type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The communication type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/getcommunicationtype"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Partially updates a communication type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/patchcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/patchcommunicationtype","metadata":{"seo":{"title":"Partially updates a communication type with the specified ID.","description":"This method will patch an existing communication type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCommunicationType","name":"Partially updates a communication type with the specified ID.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a communication type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing communication type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the communication type to patch.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/communicationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/communicationTypes/{tenantId}/{id}","href":"communication-types/patchcommunicationtype","openApiOperationId":"patchCommunicationType","summary":"Partially updates a communication type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The communication type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The communication type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/patchcommunicationtype"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Updates a communication type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/updatecommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/updatecommunicationtype","metadata":{"seo":{"title":"Updates a communication type with the specified ID.","description":"This method will update an existing communication type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCommunicationType","name":"Updates a communication type with the specified ID.","isWebhook":false,"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a communication type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing communication type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the communication type to update.","required":true}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated communication type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/communicationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/communicationTypes/{tenantId}/{id}","href":"communication-types/updatecommunicationtype","openApiOperationId":"updateCommunicationType","summary":"Updates a communication type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The communication type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}},"schemaId":"components/schemas/CommunicationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The communication type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The communication type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The communication type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve communication type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1communicationTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommunicationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommunicationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/communication-types/updatecommunicationtype"}],"panels":[]}]},"httpPath":"/communicationTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Communication Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Communication Types","showPageActions":true},{"nodeType":"markdoc","content":"Communication Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/communicationTypes/{tenantId}","summary":"Gets all of the communication types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/communication-types/listcommunicationtypes","deprecated":false},{"title":"/communicationTypes/{tenantId}","summary":"Creates a new communication type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communication-types/createcommunicationtype","deprecated":false},{"title":"/communicationTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/communication-types/executebatchoperations","deprecated":false},{"title":"/communicationTypes/{tenantId}/{id}","summary":"Returns a communication type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/communication-types/deletecommunicationtype","deprecated":false},{"title":"/communicationTypes/{tenantId}/{id}","summary":"Returns a communication type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/communication-types/getcommunicationtype","deprecated":false},{"title":"/communicationTypes/{tenantId}/{id}","summary":"Partially updates a communication type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/communication-types/patchcommunicationtype","deprecated":false},{"title":"/communicationTypes/{tenantId}/{id}","summary":"Updates a communication type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/communication-types/updatecommunicationtype","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Directories","link":"/apis/rolodex/rolodex-v1/contact-directories","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories","items":[{"label":"Gets all of the contact directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/listcontactdirectories","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/listcontactdirectories","metadata":{"seo":{"title":"Gets all of the contact directories in the system.","description":"This method will scan all contact directories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactDirectories","name":"Gets all of the contact directories in the system.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the contact directories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all contact directories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1contactDirectories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDirectories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDirectories/{tenantId}","href":"contact-directories/listcontactdirectories","openApiOperationId":"listContactDirectories","summary":"Gets all of the contact directories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/listcontactdirectories"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}"},{"label":"Creates a new contact directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/createcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/createcontactdirectory","metadata":{"seo":{"title":"Creates a new contact directory record that does not already exist.","description":"This method will auto-generate an ID and create a new contact directory. If an ID is specified for the contact directory, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactDirectory","name":"Creates a new contact directory record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact directory record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact directory. If an ID is specified for the contact directory, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","pointer":"/paths/~1contactDirectories~1{tenantId}/post/requestBody","description":"The contact directory that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDirectories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}","href":"contact-directories/createcontactdirectory","openApiOperationId":"createContactDirectory","summary":"Creates a new contact directory record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact directory you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/createcontactdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactDirectories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDirectories/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDirectories/{tenantId}/batch","href":"contact-directories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getdirectoryentry","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectoryEntry","name":"Gets an entry in the directory","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_591","description":"The id of the entry","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDirectories/{tenantId}/public/entry/{id}/{entryId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/public/entry/{id}/{entryId}","href":"contact-directories/getdirectoryentry","openApiOperationId":"getDirectoryEntry","summary":"Gets an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/getdirectoryentry"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/searchpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPublicDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDirectories/{tenantId}/public/search/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/public/search/{id}","href":"contact-directories/searchpublicdirectory","openApiOperationId":"searchPublicDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/searchpublicdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/senddirectorymessage","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendDirectoryMessage","name":"Sends a message to an entry in the directory","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends a message to an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"directoryId","in":"path","schemaId":"schema_591","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_591","description":"The id of the entry","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"schemaId":"components/schemas/DirectoryMessage","pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/requestBody","description":"The message to send"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"directoryId","in":"path","required":true,"schemaId":"schema_591"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","href":"contact-directories/senddirectorymessage","openApiOperationId":"sendDirectoryMessage","summary":"Sends a message to an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectoryMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/senddirectorymessage"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will look up a contact directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicDirectory","name":"Returns a contact directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact directory by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact directory to return.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDirectories/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDirectories/{tenantId}/public/{id}","href":"contact-directories/getpublicdirectory","openApiOperationId":"getPublicDirectory","summary":"Returns a contact directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/getpublicdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/searchdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1contactDirectories~1{tenantId}~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDirectories/{tenantId}/search/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/search/{id}","href":"contact-directories/searchdirectory","openApiOperationId":"searchDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/searchdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/search/{id}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/deletecontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/deletecontactdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will delete a contact directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContactDirectory","name":"Returns a contact directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact directory to delete.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contactDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/{id}","href":"contact-directories/deletecontactdirectory","openApiOperationId":"deleteContactDirectory","summary":"Returns a contact directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact directory could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/deletecontactdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getcontactdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will look up a contact directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactDirectory","name":"Returns a contact directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact directory by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact directory to return.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDirectories/{tenantId}/{id}","href":"contact-directories/getcontactdirectory","openApiOperationId":"getContactDirectory","summary":"Returns a contact directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/getcontactdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Partially updates a contact directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/patchcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/patchcontactdirectory","metadata":{"seo":{"title":"Partially updates a contact directory with the specified ID.","description":"This method will patch an existing contact directory with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactDirectory","name":"Partially updates a contact directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact directory with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact directory to patch.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/{id}","href":"contact-directories/patchcontactdirectory","openApiOperationId":"patchContactDirectory","summary":"Partially updates a contact directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/patchcontactdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Updates a contact directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/updatecontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/updatecontactdirectory","metadata":{"seo":{"title":"Updates a contact directory with the specified ID.","description":"This method will update an existing contact directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactDirectory","name":"Updates a contact directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact directory to update.","required":true}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/put/requestBody","description":"The updated contact directory that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDirectories/{tenantId}/{id}","href":"contact-directories/updatecontactdirectory","openApiOperationId":"updateContactDirectory","summary":"Updates a contact directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact directory was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}},"schemaId":"components/schemas/ContactDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact directory supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDirectories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-directories/updatecontactdirectory"}],"panels":[]}]},"httpPath":"/contactDirectories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Directories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Directories","showPageActions":true},{"nodeType":"markdoc","content":"Contact Directories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactDirectories/{tenantId}","summary":"Gets all of the contact directories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-directories/listcontactdirectories","deprecated":false},{"title":"/contactDirectories/{tenantId}","summary":"Creates a new contact directory record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-directories/createcontactdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-directories/executebatchoperations","deprecated":false},{"title":"/contactDirectories/{tenantId}/public/entry/{id}/{entryId}","summary":"Gets an entry in the directory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-directories/getdirectoryentry","deprecated":false},{"title":"/contactDirectories/{tenantId}/public/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-directories/searchpublicdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","summary":"Sends a message to an entry in the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-directories/senddirectorymessage","deprecated":false},{"title":"/contactDirectories/{tenantId}/public/{id}","summary":"Returns a contact directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-directories/getpublicdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-directories/searchdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/{id}","summary":"Returns a contact directory from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-directories/deletecontactdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/{id}","summary":"Returns a contact directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-directories/getcontactdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/{id}","summary":"Partially updates a contact directory with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-directories/patchcontactdirectory","deprecated":false},{"title":"/contactDirectories/{tenantId}/{id}","summary":"Updates a contact directory with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-directories/updatecontactdirectory","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Districts","link":"/apis/rolodex/rolodex-v1/contact-districts","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts","items":[{"label":"Creates a new contact district record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/createcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/createcontactdistrict","metadata":{"seo":{"title":"Creates a new contact district record that does not already exist.","description":"This method will auto-generate an ID and create a new contact district. If an ID is specified for the contact district, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactDistrict","name":"Creates a new contact district record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact district record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact district. If an ID is specified for the contact district, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","pointer":"/paths/~1contactDistricts~1{tenantId}/post/requestBody","description":"The contact district that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDistricts/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDistricts/{tenantId}","href":"contact-districts/createcontactdistrict","openApiOperationId":"createContactDistrict","summary":"Creates a new contact district record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact district was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact district you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact district could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/createcontactdistrict"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactDistricts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDistricts/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDistricts/{tenantId}/batch","href":"contact-districts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact district could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}/batch"},{"label":"Returns a contact district from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/deletecontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/deletecontactdistrict","metadata":{"seo":{"title":"Returns a contact district from the system by its ID.","description":"This method will delete a contact district with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContactDistrict","name":"Returns a contact district from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact district from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact district with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact district to delete.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contactDistricts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDistricts/{tenantId}/{id}","href":"contact-districts/deletecontactdistrict","openApiOperationId":"deleteContactDistrict","summary":"Returns a contact district from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact district was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact district could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact district could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/deletecontactdistrict"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Returns a contact district from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/getcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/getcontactdistrict","metadata":{"seo":{"title":"Returns a contact district from the system by its ID.","description":"This method will look up a contact district by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactDistrict","name":"Returns a contact district from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact district from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact district by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact district to return.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDistricts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDistricts/{tenantId}/{id}","href":"contact-districts/getcontactdistrict","openApiOperationId":"getContactDistrict","summary":"Returns a contact district from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact district was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact district could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/getcontactdistrict"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Partially updates a contact district with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/patchcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/patchcontactdistrict","metadata":{"seo":{"title":"Partially updates a contact district with the specified ID.","description":"This method will patch an existing contact district with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactDistrict","name":"Partially updates a contact district with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact district with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact district with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact district to patch.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactDistricts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDistricts/{tenantId}/{id}","href":"contact-districts/patchcontactdistrict","openApiOperationId":"patchContactDistrict","summary":"Partially updates a contact district with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact district was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact district could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact district could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/patchcontactdistrict"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Updates a contact district with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/updatecontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/updatecontactdistrict","metadata":{"seo":{"title":"Updates a contact district with the specified ID.","description":"This method will update an existing contact district with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactDistrict","name":"Updates a contact district with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact district with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact district with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact district to update.","required":true}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/put/requestBody","description":"The updated contact district that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactDistricts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDistricts/{tenantId}/{id}","href":"contact-districts/updatecontactdistrict","openApiOperationId":"updateContactDistrict","summary":"Updates a contact district with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact district was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}},"schemaId":"components/schemas/ContactDistrict","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact district supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact district could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact district could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact district based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDistricts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDistrict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDistrict"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-districts/updatecontactdistrict"}],"panels":[]}]},"httpPath":"/contactDistricts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Districts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Districts","showPageActions":true},{"nodeType":"markdoc","content":"Contact Districts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactDistricts/{tenantId}","summary":"Creates a new contact district record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-districts/createcontactdistrict","deprecated":false},{"title":"/contactDistricts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-districts/executebatchoperations","deprecated":false},{"title":"/contactDistricts/{tenantId}/{id}","summary":"Returns a contact district from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-districts/deletecontactdistrict","deprecated":false},{"title":"/contactDistricts/{tenantId}/{id}","summary":"Returns a contact district from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-districts/getcontactdistrict","deprecated":false},{"title":"/contactDistricts/{tenantId}/{id}","summary":"Partially updates a contact district with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-districts/patchcontactdistrict","deprecated":false},{"title":"/contactDistricts/{tenantId}/{id}","summary":"Updates a contact district with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-districts/updatecontactdistrict","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Duplicates","link":"/apis/rolodex/rolodex-v1/contact-duplicates","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates","items":[{"label":"Gets all of the contact duplicates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/listcontactduplicates","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/listcontactduplicates","metadata":{"seo":{"title":"Gets all of the contact duplicates in the system.","description":"This method will scan all contact duplicates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactDuplicates","name":"Gets all of the contact duplicates in the system.","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the contact duplicates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all contact duplicates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDuplicates/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDuplicates/{tenantId}","href":"contact-duplicates/listcontactduplicates","openApiOperationId":"listContactDuplicates","summary":"Gets all of the contact duplicates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact duplicateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_599"}},"schemaId":"schema_599","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_599","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_599"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/listcontactduplicates"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}"},{"label":"Search for potential duplicates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/duplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/duplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates","description":"This method searches for potential duplicates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"duplicateCheck","name":"Search for potential duplicates","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for potential duplicates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method searches for potential duplicates"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDuplicateCheck"}},"schemaId":"components/schemas/ContactDuplicateCheck","pointer":"/paths/~1contactDuplicates~1{tenantId}/post/requestBody","description":"The data you would like to try to check for duplicates"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDuplicates/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDuplicateCheck"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDuplicates/{tenantId}","href":"contact-duplicates/duplicatecheck","openApiOperationId":"duplicateCheck","summary":"Search for potential duplicates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDuplicateCheck","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDuplicateCheck"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Potential duplicates were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_600"}},"schemaId":"schema_600","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_600","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_600"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/duplicatecheck"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactDuplicates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDuplicates/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDuplicates/{tenantId}/batch","href":"contact-duplicates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}/batch"},{"label":"Search for potential duplicates in the portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/portalduplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/portalduplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates in the portal","description":"This method searches for potential duplicates and returns masked validation options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portalDuplicateCheck","name":"Search for potential duplicates in the portal","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}~1portal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for potential duplicates in the portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method searches for potential duplicates and returns masked validation options"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1portal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalSearchParams"}},"schemaId":"components/schemas/PortalSearchParams","pointer":"/paths/~1contactDuplicates~1{tenantId}~1portal/post/requestBody","description":"The data you would like to try to check for duplicates"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactDuplicates/{tenantId}/portal","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalSearchParams"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDuplicates/{tenantId}/portal","href":"contact-duplicates/portalduplicatecheck","openApiOperationId":"portalDuplicateCheck","summary":"Search for potential duplicates in the portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PortalSearchParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalSearchParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Potential duplicates were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}},"schemaId":"schema_601","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1portal/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_601","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/portalduplicatecheck"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}/portal"},{"label":"Returns a contact duplicate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/getcontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/getcontactduplicate","metadata":{"seo":{"title":"Returns a contact duplicate from the system by its ID.","description":"This method will look up a contact duplicate by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactDuplicate","name":"Returns a contact duplicate from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact duplicate from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact duplicate by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact duplicate to return.","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactDuplicates/{tenantId}/{id}","href":"contact-duplicates/getcontactduplicate","openApiOperationId":"getContactDuplicate","summary":"Returns a contact duplicate from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact duplicate was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"schemaId":"components/schemas/ContactDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/getcontactduplicate"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}/{id}"},{"label":"Partially updates a contact duplicate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/patchcontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/patchcontactduplicate","metadata":{"seo":{"title":"Partially updates a contact duplicate with the specified ID.","description":"This method will patch an existing contact duplicate with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactDuplicate","name":"Partially updates a contact duplicate with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact duplicate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact duplicate with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact duplicate to patch.","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDuplicates/{tenantId}/{id}","href":"contact-duplicates/patchcontactduplicate","openApiOperationId":"patchContactDuplicate","summary":"Partially updates a contact duplicate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact duplicate was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"schemaId":"components/schemas/ContactDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact duplicate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/patchcontactduplicate"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}/{id}"},{"label":"Updates a contact duplicate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/updatecontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/updatecontactduplicate","metadata":{"seo":{"title":"Updates a contact duplicate with the specified ID.","description":"This method will update an existing contact duplicate with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactDuplicate","name":"Updates a contact duplicate with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact duplicate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact duplicate with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact duplicate to update.","required":true}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"schemaId":"components/schemas/ContactDuplicate","pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/put/requestBody","description":"The updated contact duplicate that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactDuplicates/{tenantId}/{id}","href":"contact-duplicates/updatecontactduplicate","openApiOperationId":"updateContactDuplicate","summary":"Updates a contact duplicate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactDuplicate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact duplicate was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}},"schemaId":"components/schemas/ContactDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact duplicate supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact duplicate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactDuplicates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-duplicates/updatecontactduplicate"}],"panels":[]}]},"httpPath":"/contactDuplicates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Duplicates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Duplicates","showPageActions":true},{"nodeType":"markdoc","content":"Contact Duplicates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactDuplicates/{tenantId}","summary":"Gets all of the contact duplicates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-duplicates/listcontactduplicates","deprecated":false},{"title":"/contactDuplicates/{tenantId}","summary":"Search for potential duplicates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-duplicates/duplicatecheck","deprecated":false},{"title":"/contactDuplicates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-duplicates/executebatchoperations","deprecated":false},{"title":"/contactDuplicates/{tenantId}/portal","summary":"Search for potential duplicates in the portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-duplicates/portalduplicatecheck","deprecated":false},{"title":"/contactDuplicates/{tenantId}/{id}","summary":"Returns a contact duplicate from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-duplicates/getcontactduplicate","deprecated":false},{"title":"/contactDuplicates/{tenantId}/{id}","summary":"Partially updates a contact duplicate with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-duplicates/patchcontactduplicate","deprecated":false},{"title":"/contactDuplicates/{tenantId}/{id}","summary":"Updates a contact duplicate with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-duplicates/updatecontactduplicate","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Login Profiles","link":"/apis/rolodex/rolodex-v1/contact-login-profiles","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles","items":[{"label":"Creates a new contact login profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/createcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/createcontactloginprofile","metadata":{"seo":{"title":"Creates a new contact login profile record that does not already exist.","description":"This method will auto-generate an ID and create a new contact login profile. If an ID is specified for the contact login profile, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactLoginProfile","name":"Creates a new contact login profile record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact login profile record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact login profile. If an ID is specified for the contact login profile, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","pointer":"/paths/~1contactLoginProfiles~1{tenantId}/post/requestBody","description":"The contact login profile that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactLoginProfiles/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactLoginProfiles/{tenantId}","href":"contact-login-profiles/createcontactloginprofile","openApiOperationId":"createContactLoginProfile","summary":"Creates a new contact login profile record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact login profile was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact login profile you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact login profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/createcontactloginprofile"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactLoginProfiles/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactLoginProfiles/{tenantId}/batch","href":"contact-login-profiles/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact login profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}/batch"},{"label":"Returns a contact login profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/deletecontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/deletecontactloginprofile","metadata":{"seo":{"title":"Returns a contact login profile from the system by its ID.","description":"This method will delete a contact login profile with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContactLoginProfile","name":"Returns a contact login profile from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact login profile from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact login profile with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact login profile to delete.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contactLoginProfiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactLoginProfiles/{tenantId}/{id}","href":"contact-login-profiles/deletecontactloginprofile","openApiOperationId":"deleteContactLoginProfile","summary":"Returns a contact login profile from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact login profile was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact login profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact login profile could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/deletecontactloginprofile"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Returns a contact login profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/getcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/getcontactloginprofile","metadata":{"seo":{"title":"Returns a contact login profile from the system by its ID.","description":"This method will look up a contact login profile by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactLoginProfile","name":"Returns a contact login profile from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact login profile from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact login profile by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact login profile to return.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactLoginProfiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactLoginProfiles/{tenantId}/{id}","href":"contact-login-profiles/getcontactloginprofile","openApiOperationId":"getContactLoginProfile","summary":"Returns a contact login profile from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact login profile was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact login profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/getcontactloginprofile"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Partially updates a contact login profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/patchcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/patchcontactloginprofile","metadata":{"seo":{"title":"Partially updates a contact login profile with the specified ID.","description":"This method will patch an existing contact login profile with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactLoginProfile","name":"Partially updates a contact login profile with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact login profile with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact login profile with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact login profile to patch.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactLoginProfiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactLoginProfiles/{tenantId}/{id}","href":"contact-login-profiles/patchcontactloginprofile","openApiOperationId":"patchContactLoginProfile","summary":"Partially updates a contact login profile with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact login profile was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact login profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact login profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/patchcontactloginprofile"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Updates a contact login profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/updatecontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/updatecontactloginprofile","metadata":{"seo":{"title":"Updates a contact login profile with the specified ID.","description":"This method will update an existing contact login profile with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactLoginProfile","name":"Updates a contact login profile with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact login profile with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact login profile with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact login profile to update.","required":true}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/put/requestBody","description":"The updated contact login profile that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactLoginProfiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactLoginProfiles/{tenantId}/{id}","href":"contact-login-profiles/updatecontactloginprofile","openApiOperationId":"updateContactLoginProfile","summary":"Updates a contact login profile with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact login profile was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}},"schemaId":"components/schemas/ContactLoginProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact login profile supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact login profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact login profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact login profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactLoginProfiles~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactLoginProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactLoginProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-login-profiles/updatecontactloginprofile"}],"panels":[]}]},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Login Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Login Profiles","showPageActions":true},{"nodeType":"markdoc","content":"Contact Login Profiles"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactLoginProfiles/{tenantId}","summary":"Creates a new contact login profile record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-login-profiles/createcontactloginprofile","deprecated":false},{"title":"/contactLoginProfiles/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-login-profiles/executebatchoperations","deprecated":false},{"title":"/contactLoginProfiles/{tenantId}/{id}","summary":"Returns a contact login profile from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-login-profiles/deletecontactloginprofile","deprecated":false},{"title":"/contactLoginProfiles/{tenantId}/{id}","summary":"Returns a contact login profile from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-login-profiles/getcontactloginprofile","deprecated":false},{"title":"/contactLoginProfiles/{tenantId}/{id}","summary":"Partially updates a contact login profile with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-login-profiles/patchcontactloginprofile","deprecated":false},{"title":"/contactLoginProfiles/{tenantId}/{id}","summary":"Updates a contact login profile with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-login-profiles/updatecontactloginprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Role Rule Sets","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets","items":[{"label":"Gets all of the contact role rule sets in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/listcontactrolerulesets","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/listcontactrolerulesets","metadata":{"seo":{"title":"Gets all of the contact role rule sets in the system.","description":"This method will scan all contact role rule sets and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactRoleRuleSets","name":"Gets all of the contact role rule sets in the system.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the contact role rule sets in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all contact role rule sets and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactRoleRuleSets/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}","href":"contact-role-rule-sets/listcontactrolerulesets","openApiOperationId":"listContactRoleRuleSets","summary":"Gets all of the contact role rule sets in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule setswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_602"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/listcontactrolerulesets"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}"},{"label":"Creates a new contact role rule set record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/createcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/createcontactroleruleset","metadata":{"seo":{"title":"Creates a new contact role rule set record that does not already exist.","description":"This method will auto-generate an ID and create a new contact role rule set. If an ID is specified for the contact role rule set, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactRoleRuleSet","name":"Creates a new contact role rule set record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact role rule set record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact role rule set. If an ID is specified for the contact role rule set, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/post/requestBody","description":"The contact role rule set that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactRoleRuleSets/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}","href":"contact-role-rule-sets/createcontactroleruleset","openApiOperationId":"createContactRoleRuleSet","summary":"Creates a new contact role rule set record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule set was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact role rule set you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/createcontactroleruleset"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactRoleRuleSets/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}/batch","href":"contact-role-rule-sets/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}/batch"},{"label":"Returns a contact role rule set from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/deletecontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/deletecontactroleruleset","metadata":{"seo":{"title":"Returns a contact role rule set from the system by its ID.","description":"This method will delete a contact role rule set with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContactRoleRuleSet","name":"Returns a contact role rule set from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact role rule set from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact role rule set with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role rule set to delete.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contactRoleRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}/{id}","href":"contact-role-rule-sets/deletecontactroleruleset","openApiOperationId":"deleteContactRoleRuleSet","summary":"Returns a contact role rule set from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule set was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role rule set could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/deletecontactroleruleset"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Returns a contact role rule set from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/getcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/getcontactroleruleset","metadata":{"seo":{"title":"Returns a contact role rule set from the system by its ID.","description":"This method will look up a contact role rule set by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactRoleRuleSet","name":"Returns a contact role rule set from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact role rule set from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact role rule set by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role rule set to return.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactRoleRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}/{id}","href":"contact-role-rule-sets/getcontactroleruleset","openApiOperationId":"getContactRoleRuleSet","summary":"Returns a contact role rule set from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule set was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/getcontactroleruleset"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Partially updates a contact role rule set with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/patchcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/patchcontactroleruleset","metadata":{"seo":{"title":"Partially updates a contact role rule set with the specified ID.","description":"This method will patch an existing contact role rule set with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactRoleRuleSet","name":"Partially updates a contact role rule set with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact role rule set with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact role rule set with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role rule set to patch.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactRoleRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}/{id}","href":"contact-role-rule-sets/patchcontactroleruleset","openApiOperationId":"patchContactRoleRuleSet","summary":"Partially updates a contact role rule set with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule set was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/patchcontactroleruleset"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Updates a contact role rule set with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/updatecontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/updatecontactroleruleset","metadata":{"seo":{"title":"Updates a contact role rule set with the specified ID.","description":"This method will update an existing contact role rule set with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactRoleRuleSet","name":"Updates a contact role rule set with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact role rule set with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact role rule set with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role rule set to update.","required":true}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/put/requestBody","description":"The updated contact role rule set that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactRoleRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contactRoleRuleSets/{tenantId}/{id}","href":"contact-role-rule-sets/updatecontactroleruleset","openApiOperationId":"updateContactRoleRuleSet","summary":"Updates a contact role rule set with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role rule set was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}},"schemaId":"components/schemas/ContactRoleRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact role rule set supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoleRuleSets~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRoleRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRoleRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-role-rule-sets/updatecontactroleruleset"}],"panels":[]}]},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Role Rule Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Role Rule Sets","showPageActions":true},{"nodeType":"markdoc","content":"Contact Role Rule Sets"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactRoleRuleSets/{tenantId}","summary":"Gets all of the contact role rule sets in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-role-rule-sets/listcontactrolerulesets","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}","summary":"Creates a new contact role rule set record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-role-rule-sets/createcontactroleruleset","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-role-rule-sets/executebatchoperations","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}/{id}","summary":"Returns a contact role rule set from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-role-rule-sets/deletecontactroleruleset","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}/{id}","summary":"Returns a contact role rule set from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-role-rule-sets/getcontactroleruleset","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}/{id}","summary":"Partially updates a contact role rule set with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-role-rule-sets/patchcontactroleruleset","deprecated":false},{"title":"/contactRoleRuleSets/{tenantId}/{id}","summary":"Updates a contact role rule set with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-role-rule-sets/updatecontactroleruleset","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Roles","link":"/apis/rolodex/rolodex-v1/contact-roles","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles","items":[{"label":"Gets all of the contact roles in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/listcontactroles","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/listcontactroles","metadata":{"seo":{"title":"Gets all of the contact roles in the system.","description":"This method will scan all contact roles and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactRoles","name":"Gets all of the contact roles in the system.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the contact roles in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all contact roles and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1contactRoles~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactRoles/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoles/{tenantId}","href":"contact-roles/listcontactroles","openApiOperationId":"listContactRoles","summary":"Gets all of the contact roles in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact roleswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_603"}},"schemaId":"schema_603","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_603","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_603"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/listcontactroles"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}"},{"label":"Creates a new contact role record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/createcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/createcontactrole","metadata":{"seo":{"title":"Creates a new contact role record that does not already exist.","description":"This method will auto-generate an ID and create a new contact role. If an ID is specified for the contact role, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactRole","name":"Creates a new contact role record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact role record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact role. If an ID is specified for the contact role, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","pointer":"/paths/~1contactRoles~1{tenantId}/post/requestBody","description":"The contact role that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactRoles/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactRoles/{tenantId}","href":"contact-roles/createcontactrole","openApiOperationId":"createContactRole","summary":"Creates a new contact role record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact role you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/createcontactrole"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contactRoles~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contactRoles/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoles/{tenantId}/batch","href":"contact-roles/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/executebatchoperations"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}/batch"},{"label":"Returns a contact role from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/deletecontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/deletecontactrole","metadata":{"seo":{"title":"Returns a contact role from the system by its ID.","description":"This method will delete a contact role with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContactRole","name":"Returns a contact role from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact role from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact role with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role to delete.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contactRoles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactRoles/{tenantId}/{id}","href":"contact-roles/deletecontactrole","openApiOperationId":"deleteContactRole","summary":"Returns a contact role from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/deletecontactrole"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Returns a contact role from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/getcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/getcontactrole","metadata":{"seo":{"title":"Returns a contact role from the system by its ID.","description":"This method will look up a contact role by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactRole","name":"Returns a contact role from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact role from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact role by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role to return.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contactRoles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contactRoles/{tenantId}/{id}","href":"contact-roles/getcontactrole","openApiOperationId":"getContactRole","summary":"Returns a contact role from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/getcontactrole"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Partially updates a contact role with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/patchcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/patchcontactrole","metadata":{"seo":{"title":"Partially updates a contact role with the specified ID.","description":"This method will patch an existing contact role with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContactRole","name":"Partially updates a contact role with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact role with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact role with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role to patch.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contactRoles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactRoles/{tenantId}/{id}","href":"contact-roles/patchcontactrole","openApiOperationId":"patchContactRole","summary":"Partially updates a contact role with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/patchcontactrole"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Updates a contact role with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/updatecontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/updatecontactrole","metadata":{"seo":{"title":"Updates a contact role with the specified ID.","description":"This method will update an existing contact role with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContactRole","name":"Updates a contact role with the specified ID.","isWebhook":false,"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact role with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact role with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact role to update.","required":true}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/put/requestBody","description":"The updated contact role that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contactRoles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/contactRoles/{tenantId}/{id}","href":"contact-roles/updatecontactrole","openApiOperationId":"updateContactRole","summary":"Updates a contact role with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact role was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}},"schemaId":"components/schemas/ContactRole","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact role supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact role could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact role could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contactRoles~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactRole"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-roles/updatecontactrole"}],"panels":[]}]},"httpPath":"/contactRoles/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Contact Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Roles","showPageActions":true},{"nodeType":"markdoc","content":"Contact Roles"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contactRoles/{tenantId}","summary":"Gets all of the contact roles in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-roles/listcontactroles","deprecated":false},{"title":"/contactRoles/{tenantId}","summary":"Creates a new contact role record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-roles/createcontactrole","deprecated":false},{"title":"/contactRoles/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-roles/executebatchoperations","deprecated":false},{"title":"/contactRoles/{tenantId}/{id}","summary":"Returns a contact role from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-roles/deletecontactrole","deprecated":false},{"title":"/contactRoles/{tenantId}/{id}","summary":"Returns a contact role from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-roles/getcontactrole","deprecated":false},{"title":"/contactRoles/{tenantId}/{id}","summary":"Partially updates a contact role with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-roles/patchcontactrole","deprecated":false},{"title":"/contactRoles/{tenantId}/{id}","summary":"Updates a contact role with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-roles/updatecontactrole","deprecated":false}]}]}]}]}},{"type":"group","label":"Contacts","link":"/apis/rolodex/rolodex-v1/contacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts","items":[{"label":"Creates a new contact record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontact","metadata":{"seo":{"title":"Creates a new contact record that does not already exist.","description":"This method will auto-generate an ID and create a new contact. If an ID is specified for the contact, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContact","name":"Creates a new contact record that does not already exist.","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new contact. If an ID is specified for the contact, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","pointer":"/paths/~1contacts~1{tenantId}/post/requestBody","description":"The contact that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Contact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}","href":"contacts/createcontact","openApiOperationId":"createContact","summary":"Creates a new contact record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createcontact"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contacts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1contacts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/batch","href":"contacts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/executebatchoperations"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/batch"},{"label":"Checks whether a contact can manage another","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/checkmanageability","routeSlug":"/apis/rolodex/rolodex-v1/contacts/checkmanageability","metadata":{"seo":{"title":"Checks whether a contact can manage another","description":"Checks to see if a contact is clear to manage another contact by email addess"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkManageability","name":"Checks whether a contact can manage another","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1checkManageability~1{managerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checks whether a contact can manage another","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks to see if a contact is clear to manage another contact by email addess"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"managerId","in":"path","schemaId":"schema_591","description":"The id of the manager","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1checkManageability~1{managerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"emailAddress","in":"query","schemaId":"schema_591","description":"The email address to look up","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1checkManageability~1{managerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/checkManageability/{managerId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"managerId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"emailAddress","in":"query","required":true,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/checkManageability/{managerId}","href":"contacts/checkmanageability","openApiOperationId":"checkManageability","summary":"Checks whether a contact can manage another"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The social profile was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialProfile"}},"schemaId":"components/schemas/SocialProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The social profile was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve counts based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1checkManageability~1{managerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SocialProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/checkmanageability"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/checkManageability/{managerId}"},{"label":"Returns the contact related to the currently logged in user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcurrentcontactfromcredentials","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcurrentcontactfromcredentials","metadata":{"seo":{"title":"Returns the contact related to the currently logged in user","description":"Returns the contact related to the currently logged in user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentContactFromCredentials","name":"Returns the contact related to the currently logged in user","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the contact related to the currently logged in user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the contact related to the currently logged in user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1current/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"idToken","in":"query","schemaId":"schema_591","description":"The ID token","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1current/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/current","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"idToken","in":"query","required":true,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/current","href":"contacts/getcurrentcontactfromcredentials","openApiOperationId":"getCurrentContactFromCredentials","summary":"Returns the contact related to the currently logged in user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1current/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getcurrentcontactfromcredentials"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/current"},{"label":"Creates a new contact and links it to the currently logged in user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkuser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkuser","metadata":{"seo":{"title":"Creates a new contact and links it to the currently logged in user","description":"Returns the new contact which is linked to the currently logged in user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactAndLinkUser","name":"Creates a new contact and links it to the currently logged in user","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1current/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact and links it to the currently logged in user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the new contact which is linked to the currently logged in user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1current/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","pointer":"/paths/~1contacts~1{tenantId}~1current/post/requestBody","description":"The contact that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/current","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Contact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/current","href":"contacts/createcontactandlinkuser","openApiOperationId":"createContactAndLinkUser","summary":"Creates a new contact and links it to the currently logged in user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1current/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createcontactandlinkuser"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/current"},{"label":"Get contacts (and descendants recursively) for an organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/recursivelylistcontactsfororganizationid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/recursivelylistcontactsfororganizationid","metadata":{"seo":{"title":"Get contacts (and descendants recursively) for an organization","description":"Does a recursive lookup of contacts by organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recursivelyListContactsForOrganizationId","name":"Get contacts (and descendants recursively) for an organization","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1descendants~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts (and descendants recursively) for an organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Does a recursive lookup of contacts by organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"organization_id","in":"path","schemaId":"schema_591","description":"The organization","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1descendants~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fieldsToReturn","in":"query","schemaId":"schema_591","description":"The organization"}],"pointer":"/paths/~1contacts~1{tenantId}~1descendants~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/descendants/{organization_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/descendants/{organization_id}","href":"contacts/recursivelylistcontactsfororganizationid","openApiOperationId":"recursivelyListContactsForOrganizationId","summary":"Get contacts (and descendants recursively) for an organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The social profile was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}},"schemaId":"schema_604","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The social profile was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve counts based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1descendants~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_604","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/recursivelylistcontactsfororganizationid"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/descendants/{organization_id}"},{"label":"Returns a list of records with the specified email_address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress","metadata":{"seo":{"title":"Returns a list of records with the specified email_address","description":"Returns a list of records with the specified email_address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactsByEmailAddress","name":"Returns a list of records with the specified email_address","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress~1{email_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified email_address","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":"Returns a list of records with the specified email_address"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"email_address","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email_address to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress~1{email_address}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress~1{email_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/emailAddress/{email_address}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"email_address","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/emailAddress/{email_address}","href":"contacts/listcontactsbyemailaddress","openApiOperationId":"listContactsByEmailAddress","summary":"Returns a list of records with the specified email_address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}},"schemaId":"components/schemas/ListContactsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress~1{email_address}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactsbyemailaddress"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/emailAddress/{email_address}"},{"label":"Returns a list of records with the specified email_address2","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress2","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress2","metadata":{"seo":{"title":"Returns a list of records with the specified email_address2","description":"Returns a list of records with the specified email_address2"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactsByEmailAddress2","name":"Returns a list of records with the specified email_address2","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress2~1{email_address2}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified email_address2","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":"Returns a list of records with the specified email_address2"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"email_address2","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email_address2 to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress2~1{email_address2}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress2~1{email_address2}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/emailAddress2/{email_address2}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"email_address2","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/emailAddress2/{email_address2}","href":"contacts/listcontactsbyemailaddress2","openApiOperationId":"listContactsByEmailAddress2","summary":"Returns a list of records with the specified email_address2"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}},"schemaId":"components/schemas/ListContactsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress2~1{email_address2}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactsbyemailaddress2"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/emailAddress2/{email_address2}"},{"label":"Returns a list of records with the specified email_address3","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress3","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress3","metadata":{"seo":{"title":"Returns a list of records with the specified email_address3","description":"Returns a list of records with the specified email_address3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactsByEmailAddress3","name":"Returns a list of records with the specified email_address3","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress3~1{email_address3}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified email_address3","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":"Returns a list of records with the specified email_address3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"email_address3","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email_address3 to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress3~1{email_address3}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress3~1{email_address3}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/emailAddress3/{email_address3}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"email_address3","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/emailAddress3/{email_address3}","href":"contacts/listcontactsbyemailaddress3","openApiOperationId":"listContactsByEmailAddress3","summary":"Returns a list of records with the specified email_address3"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}},"schemaId":"components/schemas/ListContactsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1emailAddress3~1{email_address3}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactsbyemailaddress3"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/emailAddress3/{email_address3}"},{"label":"Finds all conflicting fields for contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/generatemergedobject","routeSlug":"/apis/rolodex/rolodex-v1/contacts/generatemergedobject","metadata":{"seo":{"title":"Finds all conflicting fields for contacts","description":"This method will load contacts, compare them, and return all fields that are in conflict"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateMergedObject","name":"Finds all conflicting fields for contacts","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1generateMergedObject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finds all conflicting fields for contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will load contacts, compare them, and return all fields that are in conflict"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1generateMergedObject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContactRequest"}},"schemaId":"components/schemas/MergeContactRequest","pointer":"/paths/~1contacts~1{tenantId}~1generateMergedObject/post/requestBody","description":"Comma-separated listo fIDS"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/generateMergedObject","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MergeContactRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/generateMergedObject","href":"contacts/generatemergedobject","openApiOperationId":"generateMergedObject","summary":"Finds all conflicting fields for contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MergeContactRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContactRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1generateMergedObject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/generatemergedobject"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/generateMergedObject"},{"label":"Finds all conflicting fields for contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getfieldconflicts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getfieldconflicts","metadata":{"seo":{"title":"Finds all conflicting fields for contacts","description":"This method will load contacts, compare them, and return all fields that are in conflict"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFieldConflicts","name":"Finds all conflicting fields for contacts","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1getFieldConflicts~1{ids}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finds all conflicting fields for contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will load contacts, compare them, and return all fields that are in conflict"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"ids","in":"path","schemaId":"schema_591","description":"Comma-separated listo fIDS","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1getFieldConflicts~1{ids}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/getFieldConflicts/{ids}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"ids","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/getFieldConflicts/{ids}","href":"contacts/getfieldconflicts","openApiOperationId":"getFieldConflicts","summary":"Finds all conflicting fields for contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldConflictReport"}},"schemaId":"components/schemas/FieldConflictReport","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1getFieldConflicts~1{ids}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldConflictReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldConflictReport"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getfieldconflicts"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/getFieldConflicts/{ids}"},{"label":"Returns a single contact by number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/readcontactbynumber","routeSlug":"/apis/rolodex/rolodex-v1/contacts/readcontactbynumber","metadata":{"seo":{"title":"Returns a single contact by number","description":"Returns a single contact by number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readContactByNumber","name":"Returns a single contact by number","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1number~1{number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a single contact by number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single contact by number"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"number","in":"path","schemaId":"schema_591","description":"The number to use to for record lookup","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1number~1{number}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1contacts~1{tenantId}~1number~1{number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/number/{number}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"number","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/number/{number}","href":"contacts/readcontactbynumber","openApiOperationId":"readContactByNumber","summary":"Returns a single contact by number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1number~1{number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/readcontactbynumber"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/number/{number}"},{"label":"Finds contacts for an organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyorganizationid","metadata":{"seo":{"title":"Finds contacts for an organization","description":"Returns a list of records with the specified organization_id. If the list is large, a results_uri is returned with a list that can be downloaded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactsByOrganizationId","name":"Finds contacts for an organization","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finds contacts for an organization","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":"Returns a list of records with the specified organization_id. If the list is large, a results_uri is returned with a list that can be downloaded."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"},{"name":"contactRoleIds","in":"query","schemaId":"schema_591","description":"Filter by contact role IDs"}],"pointer":"/paths/~1contacts~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"},{"name":"contactRoleIds","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/organization/{organization_id}","href":"contacts/listcontactsbyorganizationid","openApiOperationId":"listContactsByOrganizationId","summary":"Finds contacts for an organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}},"schemaId":"components/schemas/ListContactsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactsbyorganizationid"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/organization/{organization_id}"},{"label":"Returns the contact related to the currently logged in user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontactfromportaluser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontactfromportaluser","metadata":{"seo":{"title":"Returns the contact related to the currently logged in user","description":"Returns the contact related to the currently logged in user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactFromPortalUser","name":"Returns the contact related to the currently logged in user","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1portal/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the contact related to the currently logged in user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the contact related to the currently logged in user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portal/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"idToken","in":"query","schemaId":"schema_591","description":"The ID token","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portal/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/portal","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"idToken","in":"query","required":true,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/portal","href":"contacts/getcontactfromportaluser","openApiOperationId":"getContactFromPortalUser","summary":"Returns the contact related to the currently logged in user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1portal/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getcontactfromportaluser"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/portal"},{"label":"Initiates a workflow to create a new contact and try to link them to an existing organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkportaluser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkportaluser","metadata":{"seo":{"title":"Initiates a workflow to create a new contact and try to link them to an existing organization","description":"Returns the new contact which is linked to the currently logged in user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContactAndLinkPortalUser","name":"Initiates a workflow to create a new contact and try to link them to an existing organization","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1portal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates a workflow to create a new contact and try to link them to an existing organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the new contact which is linked to the currently logged in user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","pointer":"/paths/~1contacts~1{tenantId}~1portal/post/requestBody","description":"The contact that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/portal","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Contact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/portal","href":"contacts/createcontactandlinkportaluser","openApiOperationId":"createContactAndLinkPortalUser","summary":"Initiates a workflow to create a new contact and try to link them to an existing organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact creation process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1portal/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/createcontactandlinkportaluser"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/portal"},{"label":"Gets a contact by an email address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontactbyemailaddress","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontactbyemailaddress","metadata":{"seo":{"title":"Gets a contact by an email address","description":"Returns the appropriate contact ID for an email, can be called by the portal and useful in duplicate prevention"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactByEmailAddress","name":"Gets a contact by an email address","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1portal~1emailAddress~1{email_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a contact by an email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the appropriate contact ID for an email, can be called by the portal and useful in duplicate prevention"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"email_address","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email_address to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portal~1emailAddress~1{email_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/portal/emailAddress/{email_address}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"email_address","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/portal/emailAddress/{email_address}","href":"contacts/getcontactbyemailaddress","openApiOperationId":"getContactByEmailAddress","summary":"Gets a contact by an email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1portal~1emailAddress~1{email_address}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getcontactbyemailaddress"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/portal/emailAddress/{email_address}"},{"label":"Sends an authorization email then links the current user to a contact with a different email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/authorizeandlinkalternateemail","routeSlug":"/apis/rolodex/rolodex-v1/contacts/authorizeandlinkalternateemail","metadata":{"seo":{"title":"Sends an authorization email then links the current user to a contact with a different email address","description":"Sends an authorization email then links the current user to a contact with a different email address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorizeAndLinkAlternateEmail","name":"Sends an authorization email then links the current user to a contact with a different email address","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1portal~1{emailAddress}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends an authorization email then links the current user to a contact with a different email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends an authorization email then links the current user to a contact with a different email address"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"emailAddress","in":"path","schemaId":"schema_591","description":"The email address of the contact to link to.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portal~1{emailAddress}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_605"}},"schemaId":"schema_605","pointer":"/paths/~1contacts~1{tenantId}~1portal~1{emailAddress}/post/requestBody","description":"Payload options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/portal/{emailAddress}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"emailAddress","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_605"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/portal/{emailAddress}","href":"contacts/authorizeandlinkalternateemail","openApiOperationId":"authorizeAndLinkAlternateEmail","summary":"Sends an authorization email then links the current user to a contact with a different email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_605","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_605"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order process was started","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"A contact could not be found with the supplied email address","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1portal~1{emailAddress}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/authorizeandlinkalternateemail"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/portal/{emailAddress}"},{"label":"Returns a list of records with the specified portal_delegate_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyportaldelegateid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyportaldelegateid","metadata":{"seo":{"title":"Returns a list of records with the specified portal_delegate_id","description":"Returns a list of records with the specified portal_delegate_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContactsByPortalDelegateId","name":"Returns a list of records with the specified portal_delegate_id","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1portalDelegate~1{portal_delegate_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified portal_delegate_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":"Returns a list of records with the specified portal_delegate_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"portal_delegate_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portal_delegate_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1portalDelegate~1{portal_delegate_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1contacts~1{tenantId}~1portalDelegate~1{portal_delegate_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/portalDelegate/{portal_delegate_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"portal_delegate_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/portalDelegate/{portal_delegate_id}","href":"contacts/listcontactsbyportaldelegateid","openApiOperationId":"listContactsByPortalDelegateId","summary":"Returns a list of records with the specified portal_delegate_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}},"schemaId":"components/schemas/ListContactsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1portalDelegate~1{portal_delegate_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/listcontactsbyportaldelegateid"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/portalDelegate/{portal_delegate_id}"},{"label":"Searches for contacts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/searchforcontacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/searchforcontacts","metadata":{"seo":{"title":"Searches for contacts using predefined parameters","description":"Searches for contacts using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForContacts","name":"Searches for contacts using predefined parameters","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for contacts using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for contacts using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_591","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1contacts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactSearchParameters"}},"schemaId":"components/schemas/ContactSearchParameters","pointer":"/paths/~1contacts~1{tenantId}~1search/post/requestBody","description":"The contact that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/contacts/{tenantId}/search","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContactSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/search","href":"contacts/searchforcontacts","openApiOperationId":"searchForContacts","summary":"Searches for contacts using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ContactSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContactSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedContactSearchResults"}},"schemaId":"components/schemas/PagedContactSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedContactSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedContactSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/searchforcontacts"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/search"},{"label":"Looks up a social profile and returns what is found to the user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getsocialprofile","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getsocialprofile","metadata":{"seo":{"title":"Looks up a social profile and returns what is found to the user","description":"This method will make a call and parse/return the results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSocialProfile","name":"Looks up a social profile and returns what is found to the user","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1socialProfile~1{emailAddress}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Looks up a social profile and returns what is found to the user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will make a call and parse/return the results"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"emailAddress","in":"path","schemaId":"schema_591","description":"The email address to look up","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1socialProfile~1{emailAddress}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/socialProfile/{emailAddress}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"emailAddress","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/socialProfile/{emailAddress}","href":"contacts/getsocialprofile","openApiOperationId":"getSocialProfile","summary":"Looks up a social profile and returns what is found to the user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The social profile was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialProfile"}},"schemaId":"components/schemas/SocialProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The social profile was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve counts based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1socialProfile~1{emailAddress}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SocialProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getsocialprofile"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/socialProfile/{emailAddress}"},{"label":"Returns a contact from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/deletecontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/deletecontact","metadata":{"seo":{"title":"Returns a contact from the system by its ID.","description":"This method will delete a contact with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContact","name":"Returns a contact from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a contact with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact to delete.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/contacts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/{id}","href":"contacts/deletecontact","openApiOperationId":"deleteContact","summary":"Returns a contact from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/deletecontact"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Returns a contact from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontact","metadata":{"seo":{"title":"Returns a contact from the system by its ID.","description":"This method will look up a contact by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContact","name":"Returns a contact from the system by its ID.","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a contact from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a contact by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact to return.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contacts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/contacts/{tenantId}/{id}","href":"contacts/getcontact","openApiOperationId":"getContact","summary":"Returns a contact from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/getcontact"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Partially updates a contact with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/patchcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/patchcontact","metadata":{"seo":{"title":"Partially updates a contact with the specified ID.","description":"This method will patch an existing contact with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContact","name":"Partially updates a contact with the specified ID.","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a contact with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing contact with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact to patch.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1contacts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/contacts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/{id}","href":"contacts/patchcontact","openApiOperationId":"patchContact","summary":"Partially updates a contact with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/patchcontact"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Updates a contact with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/updatecontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/updatecontact","metadata":{"seo":{"title":"Updates a contact with the specified ID.","description":"This method will update an existing contact with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateContact","name":"Updates a contact with the specified ID.","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing contact with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact to update.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","pointer":"/paths/~1contacts~1{tenantId}~1{id}/put/requestBody","description":"The updated contact that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Contact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/{id}","href":"contacts/updatecontact","openApiOperationId":"updateContact","summary":"Updates a contact with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Contact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/updatecontact"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/mergecontacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/mergecontacts","metadata":{"seo":{"title":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","description":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mergeContacts","name":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","isWebhook":false,"pointer":"/paths/~1contacts~1{tenantId}~1{id}~1merge/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the contact to merge.","required":true}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}~1merge/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"schemaId":"components/schemas/MergeContact","pointer":"/paths/~1contacts~1{tenantId}~1{id}~1merge/put/requestBody","description":"The updated contact to be merged."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/contacts/{tenantId}/{id}/merge","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/contacts/{tenantId}/{id}/merge","href":"contacts/mergecontacts","openApiOperationId":"mergeContacts","summary":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MergeContact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}},"schemaId":"components/schemas/Contact","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1contacts~1{tenantId}~1{id}~1merge/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Contact","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Contact"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/mergecontacts"}],"panels":[]}]},"httpPath":"/contacts/{tenantId}/{id}/merge"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":"Contacts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contacts/{tenantId}","summary":"Creates a new contact record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/createcontact","deprecated":false},{"title":"/contacts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/executebatchoperations","deprecated":false},{"title":"/contacts/{tenantId}/checkManageability/{managerId}","summary":"Checks whether a contact can manage another","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/checkmanageability","deprecated":false},{"title":"/contacts/{tenantId}/current","summary":"Returns the contact related to the currently logged in user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getcurrentcontactfromcredentials","deprecated":false},{"title":"/contacts/{tenantId}/current","summary":"Creates a new contact and links it to the currently logged in user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/createcontactandlinkuser","deprecated":false},{"title":"/contacts/{tenantId}/descendants/{organization_id}","summary":"Get contacts (and descendants recursively) for an organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/recursivelylistcontactsfororganizationid","deprecated":false},{"title":"/contacts/{tenantId}/emailAddress/{email_address}","summary":"Returns a list of records with the specified email_address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactsbyemailaddress","deprecated":false},{"title":"/contacts/{tenantId}/emailAddress2/{email_address2}","summary":"Returns a list of records with the specified email_address2","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactsbyemailaddress2","deprecated":false},{"title":"/contacts/{tenantId}/emailAddress3/{email_address3}","summary":"Returns a list of records with the specified email_address3","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactsbyemailaddress3","deprecated":false},{"title":"/contacts/{tenantId}/generateMergedObject","summary":"Finds all conflicting fields for contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/generatemergedobject","deprecated":false},{"title":"/contacts/{tenantId}/getFieldConflicts/{ids}","summary":"Finds all conflicting fields for contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getfieldconflicts","deprecated":false},{"title":"/contacts/{tenantId}/number/{number}","summary":"Returns a single contact by number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/readcontactbynumber","deprecated":false},{"title":"/contacts/{tenantId}/organization/{organization_id}","summary":"Finds contacts for an organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactsbyorganizationid","deprecated":false},{"title":"/contacts/{tenantId}/portal","summary":"Returns the contact related to the currently logged in user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getcontactfromportaluser","deprecated":false},{"title":"/contacts/{tenantId}/portal","summary":"Initiates a workflow to create a new contact and try to link them to an existing organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/createcontactandlinkportaluser","deprecated":false},{"title":"/contacts/{tenantId}/portal/emailAddress/{email_address}","summary":"Gets a contact by an email address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getcontactbyemailaddress","deprecated":false},{"title":"/contacts/{tenantId}/portal/{emailAddress}","summary":"Sends an authorization email then links the current user to a contact with a different email address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/authorizeandlinkalternateemail","deprecated":false},{"title":"/contacts/{tenantId}/portalDelegate/{portal_delegate_id}","summary":"Returns a list of records with the specified portal_delegate_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listcontactsbyportaldelegateid","deprecated":false},{"title":"/contacts/{tenantId}/search","summary":"Searches for contacts using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/searchforcontacts","deprecated":false},{"title":"/contacts/{tenantId}/socialProfile/{emailAddress}","summary":"Looks up a social profile and returns what is found to the user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getsocialprofile","deprecated":false},{"title":"/contacts/{tenantId}/{id}","summary":"Returns a contact from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/deletecontact","deprecated":false},{"title":"/contacts/{tenantId}/{id}","summary":"Returns a contact from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getcontact","deprecated":false},{"title":"/contacts/{tenantId}/{id}","summary":"Partially updates a contact with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contacts/patchcontact","deprecated":false},{"title":"/contacts/{tenantId}/{id}","summary":"Updates a contact with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/updatecontact","deprecated":false},{"title":"/contacts/{tenantId}/{id}/merge","summary":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/mergecontacts","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Activities","link":"/apis/rolodex/rolodex-v1/custom-activities","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities","items":[{"label":"Gets all of the custom activities in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listcustomactivities","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listcustomactivities","metadata":{"seo":{"title":"Gets all of the custom activities in the system.","description":"This method will scan all custom activities and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomActivities","name":"Gets all of the custom activities in the system.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the custom activities in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all custom activities and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1customActivities~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivities/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivities/{tenantId}","href":"custom-activities/listcustomactivities","openApiOperationId":"listCustomActivities","summary":"Gets all of the custom activities in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activitieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_606"}},"schemaId":"schema_606","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_606","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_606"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/listcustomactivities"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}"},{"label":"Creates a new custom activity record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/createcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/createcustomactivity","metadata":{"seo":{"title":"Creates a new custom activity record that does not already exist.","description":"This method will auto-generate an ID and create a new custom activity. If an ID is specified for the custom activity, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomActivity","name":"Creates a new custom activity record that does not already exist.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new custom activity record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new custom activity. If an ID is specified for the custom activity, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","pointer":"/paths/~1customActivities~1{tenantId}/post/requestBody","description":"The custom activity that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customActivities/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/customActivities/{tenantId}","href":"custom-activities/createcustomactivity","openApiOperationId":"createCustomActivity","summary":"Creates a new custom activity record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom activity you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/createcustomactivity"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1customActivities~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customActivities/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivities/{tenantId}/batch","href":"custom-activities/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/executebatchoperations"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbycontactid","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivitiesByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1customActivities~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivities/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivities/{tenantId}/contact/{contact_id}","href":"custom-activities/listactivitiesbycontactid","openApiOperationId":"listActivitiesByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomActivitiesResponse"}},"schemaId":"components/schemas/ListCustomActivitiesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCustomActivitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomActivitiesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/listactivitiesbycontactid"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbyorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivitiesByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_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":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1customActivities~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivities/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivities/{tenantId}/organization/{organization_id}","href":"custom-activities/listactivitiesbyorganizationid","openApiOperationId":"listActivitiesByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomActivitiesResponse"}},"schemaId":"components/schemas/ListCustomActivitiesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCustomActivitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomActivitiesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/listactivitiesbyorganizationid"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/organization/{organization_id}"},{"label":"Returns a custom activity from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/deletecustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/deletecustomactivity","metadata":{"seo":{"title":"Returns a custom activity from the system by its ID.","description":"This method will delete a custom activity with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomActivity","name":"Returns a custom activity from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom activity from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a custom activity with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity to delete.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customActivities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/customActivities/{tenantId}/{id}","href":"custom-activities/deletecustomactivity","openApiOperationId":"deleteCustomActivity","summary":"Returns a custom activity from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/deletecustomactivity"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Returns a custom activity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/getcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/getcustomactivity","metadata":{"seo":{"title":"Returns a custom activity from the system by its ID.","description":"This method will look up a custom activity by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomActivity","name":"Returns a custom activity from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom activity from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a custom activity by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity to return.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivities/{tenantId}/{id}","href":"custom-activities/getcustomactivity","openApiOperationId":"getCustomActivity","summary":"Returns a custom activity from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/getcustomactivity"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Partially updates a custom activity with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/patchcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/patchcustomactivity","metadata":{"seo":{"title":"Partially updates a custom activity with the specified ID.","description":"This method will patch an existing custom activity with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomActivity","name":"Partially updates a custom activity with the specified ID.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a custom activity with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing custom activity with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity to patch.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1customActivities~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customActivities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/customActivities/{tenantId}/{id}","href":"custom-activities/patchcustomactivity","openApiOperationId":"patchCustomActivity","summary":"Partially updates a custom activity with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/patchcustomactivity"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Updates a custom activity with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/updatecustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/updatecustomactivity","metadata":{"seo":{"title":"Updates a custom activity with the specified ID.","description":"This method will update an existing custom activity with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomActivity","name":"Updates a custom activity with the specified ID.","isWebhook":false,"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a custom activity with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing custom activity with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity to update.","required":true}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","pointer":"/paths/~1customActivities~1{tenantId}~1{id}/put/requestBody","description":"The updated custom activity that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customActivities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/customActivities/{tenantId}/{id}","href":"custom-activities/updatecustomactivity","openApiOperationId":"updateCustomActivity","summary":"Updates a custom activity with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}},"schemaId":"components/schemas/CustomActivity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom activity supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivities~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activities/updatecustomactivity"}],"panels":[]}]},"httpPath":"/customActivities/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Activities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Activities","showPageActions":true},{"nodeType":"markdoc","content":"Custom Activities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customActivities/{tenantId}","summary":"Gets all of the custom activities in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activities/listcustomactivities","deprecated":false},{"title":"/customActivities/{tenantId}","summary":"Creates a new custom activity record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-activities/createcustomactivity","deprecated":false},{"title":"/customActivities/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-activities/executebatchoperations","deprecated":false},{"title":"/customActivities/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activities/listactivitiesbycontactid","deprecated":false},{"title":"/customActivities/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activities/listactivitiesbyorganizationid","deprecated":false},{"title":"/customActivities/{tenantId}/{id}","summary":"Returns a custom activity from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-activities/deletecustomactivity","deprecated":false},{"title":"/customActivities/{tenantId}/{id}","summary":"Returns a custom activity from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activities/getcustomactivity","deprecated":false},{"title":"/customActivities/{tenantId}/{id}","summary":"Partially updates a custom activity with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-activities/patchcustomactivity","deprecated":false},{"title":"/customActivities/{tenantId}/{id}","summary":"Updates a custom activity with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-activities/updatecustomactivity","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Activity Types","link":"/apis/rolodex/rolodex-v1/custom-activity-types","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types","items":[{"label":"Gets all of the custom activity types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/listcustomactivitytypes","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/listcustomactivitytypes","metadata":{"seo":{"title":"Gets all of the custom activity types in the system.","description":"This method will scan all custom activity types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomActivityTypes","name":"Gets all of the custom activity types in the system.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the custom activity types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all custom activity types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivityTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivityTypes/{tenantId}","href":"custom-activity-types/listcustomactivitytypes","openApiOperationId":"listCustomActivityTypes","summary":"Gets all of the custom activity types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_607"}},"schemaId":"schema_607","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_607","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_607"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/listcustomactivitytypes"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}"},{"label":"Creates a new custom activity type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/createcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/createcustomactivitytype","metadata":{"seo":{"title":"Creates a new custom activity type record that does not already exist.","description":"This method will auto-generate an ID and create a new custom activity type. If an ID is specified for the custom activity type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomActivityType","name":"Creates a new custom activity type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new custom activity type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new custom activity type. If an ID is specified for the custom activity type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","pointer":"/paths/~1customActivityTypes~1{tenantId}/post/requestBody","description":"The custom activity type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customActivityTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customActivityTypes/{tenantId}","href":"custom-activity-types/createcustomactivitytype","openApiOperationId":"createCustomActivityType","summary":"Creates a new custom activity type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom activity type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/createcustomactivitytype"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1customActivityTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customActivityTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivityTypes/{tenantId}/batch","href":"custom-activity-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}/batch"},{"label":"Returns a custom activity type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/deletecustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/deletecustomactivitytype","metadata":{"seo":{"title":"Returns a custom activity type from the system by its ID.","description":"This method will delete a custom activity type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomActivityType","name":"Returns a custom activity type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom activity type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a custom activity type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity type to delete.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customActivityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customActivityTypes/{tenantId}/{id}","href":"custom-activity-types/deletecustomactivitytype","openApiOperationId":"deleteCustomActivityType","summary":"Returns a custom activity type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/deletecustomactivitytype"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Returns a custom activity type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/getcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/getcustomactivitytype","metadata":{"seo":{"title":"Returns a custom activity type from the system by its ID.","description":"This method will look up a custom activity type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomActivityType","name":"Returns a custom activity type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom activity type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a custom activity type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity type to return.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customActivityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customActivityTypes/{tenantId}/{id}","href":"custom-activity-types/getcustomactivitytype","openApiOperationId":"getCustomActivityType","summary":"Returns a custom activity type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/getcustomactivitytype"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Partially updates a custom activity type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/patchcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/patchcustomactivitytype","metadata":{"seo":{"title":"Partially updates a custom activity type with the specified ID.","description":"This method will patch an existing custom activity type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomActivityType","name":"Partially updates a custom activity type with the specified ID.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a custom activity type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing custom activity type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity type to patch.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customActivityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customActivityTypes/{tenantId}/{id}","href":"custom-activity-types/patchcustomactivitytype","openApiOperationId":"patchCustomActivityType","summary":"Partially updates a custom activity type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/patchcustomactivitytype"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Updates a custom activity type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/updatecustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/updatecustomactivitytype","metadata":{"seo":{"title":"Updates a custom activity type with the specified ID.","description":"This method will update an existing custom activity type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomActivityType","name":"Updates a custom activity type with the specified ID.","isWebhook":false,"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a custom activity type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing custom activity type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom activity type to update.","required":true}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated custom activity type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customActivityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customActivityTypes/{tenantId}/{id}","href":"custom-activity-types/updatecustomactivitytype","openApiOperationId":"updateCustomActivityType","summary":"Updates a custom activity type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom activity type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}},"schemaId":"components/schemas/CustomActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom activity type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customActivityTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-activity-types/updatecustomactivitytype"}],"panels":[]}]},"httpPath":"/customActivityTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Activity Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Activity Types","showPageActions":true},{"nodeType":"markdoc","content":"Custom Activity Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customActivityTypes/{tenantId}","summary":"Gets all of the custom activity types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activity-types/listcustomactivitytypes","deprecated":false},{"title":"/customActivityTypes/{tenantId}","summary":"Creates a new custom activity type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-activity-types/createcustomactivitytype","deprecated":false},{"title":"/customActivityTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-activity-types/executebatchoperations","deprecated":false},{"title":"/customActivityTypes/{tenantId}/{id}","summary":"Returns a custom activity type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-activity-types/deletecustomactivitytype","deprecated":false},{"title":"/customActivityTypes/{tenantId}/{id}","summary":"Returns a custom activity type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-activity-types/getcustomactivitytype","deprecated":false},{"title":"/customActivityTypes/{tenantId}/{id}","summary":"Partially updates a custom activity type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-activity-types/patchcustomactivitytype","deprecated":false},{"title":"/customActivityTypes/{tenantId}/{id}","summary":"Updates a custom activity type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-activity-types/updatecustomactivitytype","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Engagement Metrics","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics","items":[{"label":"Gets all of the custom engagement metrics in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/listcustomengagementmetrics","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/listcustomengagementmetrics","metadata":{"seo":{"title":"Gets all of the custom engagement metrics in the system.","description":"This method will scan all custom engagement metrics and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomEngagementMetrics","name":"Gets all of the custom engagement metrics in the system.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the custom engagement metrics in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all custom engagement metrics and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customEngagementMetrics/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customEngagementMetrics/{tenantId}","href":"custom-engagement-metrics/listcustomengagementmetrics","openApiOperationId":"listCustomEngagementMetrics","summary":"Gets all of the custom engagement metrics in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metricswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_608"}},"schemaId":"schema_608","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_608","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_608"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/listcustomengagementmetrics"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}"},{"label":"Creates a new custom engagement metric record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/createcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/createcustomengagementmetric","metadata":{"seo":{"title":"Creates a new custom engagement metric record that does not already exist.","description":"This method will auto-generate an ID and create a new custom engagement metric. If an ID is specified for the custom engagement metric, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomEngagementMetric","name":"Creates a new custom engagement metric record that does not already exist.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new custom engagement metric record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new custom engagement metric. If an ID is specified for the custom engagement metric, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","pointer":"/paths/~1customEngagementMetrics~1{tenantId}/post/requestBody","description":"The custom engagement metric that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customEngagementMetrics/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customEngagementMetrics/{tenantId}","href":"custom-engagement-metrics/createcustomengagementmetric","openApiOperationId":"createCustomEngagementMetric","summary":"Creates a new custom engagement metric record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metric was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom engagement metric you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom engagement metric could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/createcustomengagementmetric"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customEngagementMetrics/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customEngagementMetrics/{tenantId}/batch","href":"custom-engagement-metrics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom engagement metric could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/executebatchoperations"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}/batch"},{"label":"Returns a custom engagement metric from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/deletecustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/deletecustomengagementmetric","metadata":{"seo":{"title":"Returns a custom engagement metric from the system by its ID.","description":"This method will delete a custom engagement metric with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomEngagementMetric","name":"Returns a custom engagement metric from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom engagement metric from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a custom engagement metric with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom engagement metric to delete.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customEngagementMetrics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customEngagementMetrics/{tenantId}/{id}","href":"custom-engagement-metrics/deletecustomengagementmetric","openApiOperationId":"deleteCustomEngagementMetric","summary":"Returns a custom engagement metric from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metric was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom engagement metric could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom engagement metric could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/deletecustomengagementmetric"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Returns a custom engagement metric from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/getcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/getcustomengagementmetric","metadata":{"seo":{"title":"Returns a custom engagement metric from the system by its ID.","description":"This method will look up a custom engagement metric by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomEngagementMetric","name":"Returns a custom engagement metric from the system by its ID.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a custom engagement metric from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a custom engagement metric by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom engagement metric to return.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customEngagementMetrics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/customEngagementMetrics/{tenantId}/{id}","href":"custom-engagement-metrics/getcustomengagementmetric","openApiOperationId":"getCustomEngagementMetric","summary":"Returns a custom engagement metric from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metric was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom engagement metric could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/getcustomengagementmetric"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Partially updates a custom engagement metric with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/patchcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/patchcustomengagementmetric","metadata":{"seo":{"title":"Partially updates a custom engagement metric with the specified ID.","description":"This method will patch an existing custom engagement metric with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCustomEngagementMetric","name":"Partially updates a custom engagement metric with the specified ID.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a custom engagement metric with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing custom engagement metric with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom engagement metric to patch.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customEngagementMetrics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customEngagementMetrics/{tenantId}/{id}","href":"custom-engagement-metrics/patchcustomengagementmetric","openApiOperationId":"patchCustomEngagementMetric","summary":"Partially updates a custom engagement metric with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metric was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom engagement metric could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom engagement metric could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/patchcustomengagementmetric"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Updates a custom engagement metric with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/updatecustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/updatecustomengagementmetric","metadata":{"seo":{"title":"Updates a custom engagement metric with the specified ID.","description":"This method will update an existing custom engagement metric with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomEngagementMetric","name":"Updates a custom engagement metric with the specified ID.","isWebhook":false,"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a custom engagement metric with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing custom engagement metric with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the custom engagement metric to update.","required":true}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/put/requestBody","description":"The updated custom engagement metric that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customEngagementMetrics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/customEngagementMetrics/{tenantId}/{id}","href":"custom-engagement-metrics/updatecustomengagementmetric","openApiOperationId":"updateCustomEngagementMetric","summary":"Updates a custom engagement metric with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The custom engagement metric was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}},"schemaId":"components/schemas/CustomEngagementMetric","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The custom engagement metric supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The custom engagement metric could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The custom engagement metric could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve custom engagement metric based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1customEngagementMetrics~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomEngagementMetric","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomEngagementMetric"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-engagement-metrics/updatecustomengagementmetric"}],"panels":[]}]},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Custom Engagement Metrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Engagement Metrics","showPageActions":true},{"nodeType":"markdoc","content":"Custom Engagement Metrics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customEngagementMetrics/{tenantId}","summary":"Gets all of the custom engagement metrics in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-engagement-metrics/listcustomengagementmetrics","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}","summary":"Creates a new custom engagement metric record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-engagement-metrics/createcustomengagementmetric","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-engagement-metrics/executebatchoperations","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}/{id}","summary":"Returns a custom engagement metric from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-engagement-metrics/deletecustomengagementmetric","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}/{id}","summary":"Returns a custom engagement metric from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-engagement-metrics/getcustomengagementmetric","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}/{id}","summary":"Partially updates a custom engagement metric with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-engagement-metrics/patchcustomengagementmetric","deprecated":false},{"title":"/customEngagementMetrics/{tenantId}/{id}","summary":"Updates a custom engagement metric with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-engagement-metrics/updatecustomengagementmetric","deprecated":false}]}]}]}]}},{"type":"group","label":"Engagement Categories","link":"/apis/rolodex/rolodex-v1/engagement-categories","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories","items":[{"label":"Gets all of the engagement categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/listengagementcategories","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/listengagementcategories","metadata":{"seo":{"title":"Gets all of the engagement categories in the system.","description":"This method will scan all engagement categories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEngagementCategories","name":"Gets all of the engagement categories in the system.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the engagement categories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all engagement categories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1engagementCategories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementCategories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementCategories/{tenantId}","href":"engagement-categories/listengagementcategories","openApiOperationId":"listEngagementCategories","summary":"Gets all of the engagement categories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement categorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}},"schemaId":"schema_609","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_609","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/listengagementcategories"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}"},{"label":"Creates a new engagement category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/createengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/createengagementcategory","metadata":{"seo":{"title":"Creates a new engagement category record that does not already exist.","description":"This method will auto-generate an ID and create a new engagement category. If an ID is specified for the engagement category, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEngagementCategory","name":"Creates a new engagement category record that does not already exist.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new engagement category record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new engagement category. If an ID is specified for the engagement category, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","pointer":"/paths/~1engagementCategories~1{tenantId}/post/requestBody","description":"The engagement category that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementCategories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementCategories/{tenantId}","href":"engagement-categories/createengagementcategory","openApiOperationId":"createEngagementCategory","summary":"Creates a new engagement category record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement category was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The engagement category you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/createengagementcategory"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1engagementCategories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementCategories/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementCategories/{tenantId}/batch","href":"engagement-categories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/executebatchoperations"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}/batch"},{"label":"Returns a engagement category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/deleteengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/deleteengagementcategory","metadata":{"seo":{"title":"Returns a engagement category from the system by its ID.","description":"This method will delete a engagement category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEngagementCategory","name":"Returns a engagement category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a engagement category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a engagement category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement category to delete.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/engagementCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementCategories/{tenantId}/{id}","href":"engagement-categories/deleteengagementcategory","openApiOperationId":"deleteEngagementCategory","summary":"Returns a engagement category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement category was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement category could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/deleteengagementcategory"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Returns a engagement category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/getengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/getengagementcategory","metadata":{"seo":{"title":"Returns a engagement category from the system by its ID.","description":"This method will look up a engagement category by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEngagementCategory","name":"Returns a engagement category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a engagement category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a engagement category by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement category to return.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementCategories/{tenantId}/{id}","href":"engagement-categories/getengagementcategory","openApiOperationId":"getEngagementCategory","summary":"Returns a engagement category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement category was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/getengagementcategory"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Partially updates a engagement category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/patchengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/patchengagementcategory","metadata":{"seo":{"title":"Partially updates a engagement category with the specified ID.","description":"This method will patch an existing engagement category with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEngagementCategory","name":"Partially updates a engagement category with the specified ID.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a engagement category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing engagement category with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement category to patch.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/engagementCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementCategories/{tenantId}/{id}","href":"engagement-categories/patchengagementcategory","openApiOperationId":"patchEngagementCategory","summary":"Partially updates a engagement category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement category was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/patchengagementcategory"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Updates a engagement category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/updateengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/updateengagementcategory","metadata":{"seo":{"title":"Updates a engagement category with the specified ID.","description":"This method will update an existing engagement category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEngagementCategory","name":"Updates a engagement category with the specified ID.","isWebhook":false,"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a engagement category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing engagement category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement category to update.","required":true}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/put/requestBody","description":"The updated engagement category that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/engagementCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementCategories/{tenantId}/{id}","href":"engagement-categories/updateengagementcategory","openApiOperationId":"updateEngagementCategory","summary":"Updates a engagement category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement category was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}},"schemaId":"components/schemas/EngagementCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The engagement category supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementCategories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-categories/updateengagementcategory"}],"panels":[]}]},"httpPath":"/engagementCategories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Engagement Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Engagement Categories","showPageActions":true},{"nodeType":"markdoc","content":"Engagement Categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/engagementCategories/{tenantId}","summary":"Gets all of the engagement categories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-categories/listengagementcategories","deprecated":false},{"title":"/engagementCategories/{tenantId}","summary":"Creates a new engagement category record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-categories/createengagementcategory","deprecated":false},{"title":"/engagementCategories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-categories/executebatchoperations","deprecated":false},{"title":"/engagementCategories/{tenantId}/{id}","summary":"Returns a engagement category from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/engagement-categories/deleteengagementcategory","deprecated":false},{"title":"/engagementCategories/{tenantId}/{id}","summary":"Returns a engagement category from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-categories/getengagementcategory","deprecated":false},{"title":"/engagementCategories/{tenantId}/{id}","summary":"Partially updates a engagement category with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/engagement-categories/patchengagementcategory","deprecated":false},{"title":"/engagementCategories/{tenantId}/{id}","summary":"Updates a engagement category with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/engagement-categories/updateengagementcategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Engagement Models","link":"/apis/rolodex/rolodex-v1/engagement-models","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models","items":[{"label":"Gets all of the engagement models in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/listengagementmodels","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/listengagementmodels","metadata":{"seo":{"title":"Gets all of the engagement models in the system.","description":"This method will scan all engagement models and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEngagementModels","name":"Gets all of the engagement models in the system.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the engagement models in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all engagement models and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1engagementModels~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementModels/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementModels/{tenantId}","href":"engagement-models/listengagementmodels","openApiOperationId":"listEngagementModels","summary":"Gets all of the engagement models in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement modelswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}},"schemaId":"schema_610","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_610","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/listengagementmodels"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}"},{"label":"Creates a new engagement model record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/createengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/createengagementmodel","metadata":{"seo":{"title":"Creates a new engagement model record that does not already exist.","description":"This method will auto-generate an ID and create a new engagement model. If an ID is specified for the engagement model, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEngagementModel","name":"Creates a new engagement model record that does not already exist.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new engagement model record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new engagement model. If an ID is specified for the engagement model, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","pointer":"/paths/~1engagementModels~1{tenantId}/post/requestBody","description":"The engagement model that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementModels/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementModels/{tenantId}","href":"engagement-models/createengagementmodel","openApiOperationId":"createEngagementModel","summary":"Creates a new engagement model record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement model was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The engagement model you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement model could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/createengagementmodel"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1engagementModels~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementModels/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementModels/{tenantId}/batch","href":"engagement-models/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement model could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/executebatchoperations"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}/batch"},{"label":"Returns a engagement model from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/deleteengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/deleteengagementmodel","metadata":{"seo":{"title":"Returns a engagement model from the system by its ID.","description":"This method will delete a engagement model with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEngagementModel","name":"Returns a engagement model from the system by its ID.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a engagement model from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a engagement model with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement model to delete.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/engagementModels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementModels/{tenantId}/{id}","href":"engagement-models/deleteengagementmodel","openApiOperationId":"deleteEngagementModel","summary":"Returns a engagement model from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement model was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement model could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement model could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/deleteengagementmodel"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Returns a engagement model from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/getengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/getengagementmodel","metadata":{"seo":{"title":"Returns a engagement model from the system by its ID.","description":"This method will look up a engagement model by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEngagementModel","name":"Returns a engagement model from the system by its ID.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a engagement model from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a engagement model by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement model to return.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementModels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementModels/{tenantId}/{id}","href":"engagement-models/getengagementmodel","openApiOperationId":"getEngagementModel","summary":"Returns a engagement model from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement model was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement model could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/getengagementmodel"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Partially updates a engagement model with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/patchengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/patchengagementmodel","metadata":{"seo":{"title":"Partially updates a engagement model with the specified ID.","description":"This method will patch an existing engagement model with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEngagementModel","name":"Partially updates a engagement model with the specified ID.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a engagement model with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing engagement model with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement model to patch.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/engagementModels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementModels/{tenantId}/{id}","href":"engagement-models/patchengagementmodel","openApiOperationId":"patchEngagementModel","summary":"Partially updates a engagement model with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement model was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement model could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement model could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/patchengagementmodel"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Updates a engagement model with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/updateengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/updateengagementmodel","metadata":{"seo":{"title":"Updates a engagement model with the specified ID.","description":"This method will update an existing engagement model with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEngagementModel","name":"Updates a engagement model with the specified ID.","isWebhook":false,"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a engagement model with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing engagement model with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement model to update.","required":true}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/put/requestBody","description":"The updated engagement model that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/engagementModels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/engagementModels/{tenantId}/{id}","href":"engagement-models/updateengagementmodel","openApiOperationId":"updateEngagementModel","summary":"Updates a engagement model with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement model was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}},"schemaId":"components/schemas/EngagementModel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The engagement model supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement model could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The engagement model could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement model based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementModels~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementModel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-models/updateengagementmodel"}],"panels":[]}]},"httpPath":"/engagementModels/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Engagement Models"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Engagement Models","showPageActions":true},{"nodeType":"markdoc","content":"Engagement Models"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/engagementModels/{tenantId}","summary":"Gets all of the engagement models in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-models/listengagementmodels","deprecated":false},{"title":"/engagementModels/{tenantId}","summary":"Creates a new engagement model record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-models/createengagementmodel","deprecated":false},{"title":"/engagementModels/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-models/executebatchoperations","deprecated":false},{"title":"/engagementModels/{tenantId}/{id}","summary":"Returns a engagement model from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/engagement-models/deleteengagementmodel","deprecated":false},{"title":"/engagementModels/{tenantId}/{id}","summary":"Returns a engagement model from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-models/getengagementmodel","deprecated":false},{"title":"/engagementModels/{tenantId}/{id}","summary":"Partially updates a engagement model with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/engagement-models/patchengagementmodel","deprecated":false},{"title":"/engagementModels/{tenantId}/{id}","summary":"Updates a engagement model with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/engagement-models/updateengagementmodel","deprecated":false}]}]}]}]}},{"type":"group","label":"Engagement Scores","link":"/apis/rolodex/rolodex-v1/engagement-scores","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores","items":[{"label":"Returns a list of records with the specified customer_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/listscoresbycustomerid","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/listscoresbycustomerid","metadata":{"seo":{"title":"Returns a list of records with the specified customer_id","description":"Returns a list of records with the specified customer_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listScoresByCustomerId","name":"Returns a list of records with the specified customer_id","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1customer~1{customer_type}~1{customer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified customer_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":"Returns a list of records with the specified customer_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"customer_type","in":"path","schemaId":"schema_611","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"customer_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1customer~1{customer_type}~1{customer_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1customer~1{customer_type}~1{customer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"customer_type","in":"path","required":true,"schemaId":"schema_611"},{"name":"customer_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}","href":"engagement-scores/listscoresbycustomerid","openApiOperationId":"listScoresByCustomerId","summary":"Returns a list of records with the specified customer_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEngagementScoresResponse"}},"schemaId":"components/schemas/ListEngagementScoresResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1customer~1{customer_type}~1{customer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEngagementScoresResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEngagementScoresResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/listscoresbycustomerid"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}"},{"label":"Get Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getmetrics","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getmetrics","metadata":{"seo":{"title":"Get Metrics","description":"Gets a list of all metrics"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMetrics","name":"Get Metrics","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of all metrics"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementScores/{tenantId}/metrics","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/metrics","href":"engagement-scores/getmetrics","openApiOperationId":"getMetrics","summary":"Get Metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricsResponse"}},"schemaId":"components/schemas/GetMetricsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/getmetrics"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/metrics"},{"label":"Initiate Engagement Metric Lookback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/performlookback","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/performlookback","metadata":{"seo":{"title":"Initiate Engagement Metric Lookback","description":"Initiates a lookback write of engagement-related data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"performLookback","name":"Initiate Engagement Metric Lookback","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1performLookback/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate Engagement Metric Lookback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiates a lookback write of engagement-related data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1performLookback/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementScores/{tenantId}/performLookback","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/performLookback","href":"engagement-scores/performlookback","openApiOperationId":"performLookback","summary":"Initiate Engagement Metric Lookback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1performLookback/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/performlookback"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/performLookback"},{"label":"Get Raw Metric Data for Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getrawmetricdataforcustomer","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getrawmetricdataforcustomer","metadata":{"seo":{"title":"Get Raw Metric Data for Customer","description":"Gets the raw metric data for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRawMetricDataForCustomer","name":"Get Raw Metric Data for Customer","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1rawMetricData~1{customerType}~1{customerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Raw Metric Data for Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the raw metric data for a customer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"customerType","in":"path","schemaId":"schema_611","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"customerId","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1rawMetricData~1{customerType}~1{customerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date","in":"query","schemaId":"schema_591","description":"The optional date"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1rawMetricData~1{customerType}~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_611"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"date","in":"query","schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}","href":"engagement-scores/getrawmetricdataforcustomer","openApiOperationId":"getRawMetricDataForCustomer","summary":"Get Raw Metric Data for Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomerRawMetricDataResponse"}},"schemaId":"components/schemas/GetCustomerRawMetricDataResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1rawMetricData~1{customerType}~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomerRawMetricDataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomerRawMetricDataResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/getrawmetricdataforcustomer"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}"},{"label":"Regenerate scores","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/regeneratescores","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/regeneratescores","metadata":{"seo":{"title":"Regenerate scores","description":"Regenerates scores when a scoring model has changed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"regenerateScores","name":"Regenerate scores","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1regenerateScores/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate scores","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Regenerates scores when a scoring model has changed"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1regenerateScores/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/engagementScores/{tenantId}/regenerateScores","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/regenerateScores","href":"engagement-scores/regeneratescores","openApiOperationId":"regenerateScores","summary":"Regenerate scores"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1regenerateScores/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/regeneratescores"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/regenerateScores"},{"label":"Returns a engagement score from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getengagementscore","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getengagementscore","metadata":{"seo":{"title":"Returns a engagement score from the system by its ID.","description":"This method will look up a engagement score by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEngagementScore","name":"Returns a engagement score from the system by its ID.","isWebhook":false,"pointer":"/paths/~1engagementScores~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a engagement score from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a engagement score by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the engagement score to return.","required":true}],"pointer":"/paths/~1engagementScores~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1engagementScores~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/engagementScores/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/engagementScores/{tenantId}/{id}","href":"engagement-scores/getengagementscore","openApiOperationId":"getEngagementScore","summary":"Returns a engagement score from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The engagement score was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementScore"}},"schemaId":"components/schemas/EngagementScore","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The engagement score could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve engagement score based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1engagementScores~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EngagementScore","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EngagementScore"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/engagement-scores/getengagementscore"}],"panels":[]}]},"httpPath":"/engagementScores/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Engagement Scores"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Engagement Scores","showPageActions":true},{"nodeType":"markdoc","content":"Engagement Scores"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}","summary":"Returns a list of records with the specified customer_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-scores/listscoresbycustomerid","deprecated":false},{"title":"/engagementScores/{tenantId}/metrics","summary":"Get Metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-scores/getmetrics","deprecated":false},{"title":"/engagementScores/{tenantId}/performLookback","summary":"Initiate Engagement Metric Lookback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-scores/performlookback","deprecated":false},{"title":"/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}","summary":"Get Raw Metric Data for Customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-scores/getrawmetricdataforcustomer","deprecated":false},{"title":"/engagementScores/{tenantId}/regenerateScores","summary":"Regenerate scores","prefix":{"name":"post","color":"post"},"badges":[],"link":"/engagement-scores/regeneratescores","deprecated":false},{"title":"/engagementScores/{tenantId}/{id}","summary":"Returns a engagement score from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/engagement-scores/getengagementscore","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Directories","link":"/apis/rolodex/rolodex-v1/organization-directories","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories","items":[{"label":"Gets all of the organization directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/listorganizationdirectories","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/listorganizationdirectories","metadata":{"seo":{"title":"Gets all of the organization directories in the system.","description":"This method will scan all organization directories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrganizationDirectories","name":"Gets all of the organization directories in the system.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the organization directories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all organization directories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDirectories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationDirectories/{tenantId}","href":"organization-directories/listorganizationdirectories","openApiOperationId":"listOrganizationDirectories","summary":"Gets all of the organization directories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/listorganizationdirectories"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}"},{"label":"Creates a new organization directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/createorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/createorganizationdirectory","metadata":{"seo":{"title":"Creates a new organization directory record that does not already exist.","description":"This method will auto-generate an ID and create a new organization directory. If an ID is specified for the organization directory, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrganizationDirectory","name":"Creates a new organization directory record that does not already exist.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new organization directory record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new organization directory. If an ID is specified for the organization directory, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","pointer":"/paths/~1organizationDirectories~1{tenantId}/post/requestBody","description":"The organization directory that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDirectories/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}","href":"organization-directories/createorganizationdirectory","openApiOperationId":"createOrganizationDirectory","summary":"Creates a new organization directory record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization directory you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/createorganizationdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1organizationDirectories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDirectories/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationDirectories/{tenantId}/batch","href":"organization-directories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/executebatchoperations"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getdirectoryentry","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectoryEntry","name":"Gets an entry in the directory","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_591","description":"The id of the entry","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDirectories/{tenantId}/public/entry/{id}/{entryId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/public/entry/{id}/{entryId}","href":"organization-directories/getdirectoryentry","openApiOperationId":"getDirectoryEntry","summary":"Gets an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/getdirectoryentry"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/searchpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPublicDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDirectories/{tenantId}/public/search/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/public/search/{id}","href":"organization-directories/searchpublicdirectory","openApiOperationId":"searchPublicDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/searchpublicdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/senddirectorymessage","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendDirectoryMessage","name":"Sends a message to an entry in the directory","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends a message to an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"directoryId","in":"path","schemaId":"schema_591","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_591","description":"The id of the entry","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"schemaId":"components/schemas/DirectoryMessage","pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/requestBody","description":"The message to send"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"directoryId","in":"path","required":true,"schemaId":"schema_591"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","href":"organization-directories/senddirectorymessage","openApiOperationId":"sendDirectoryMessage","summary":"Sends a message to an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectoryMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/senddirectorymessage"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will look up a organization directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicDirectory","name":"Returns a organization directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a organization directory by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization directory to return.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDirectories/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationDirectories/{tenantId}/public/{id}","href":"organization-directories/getpublicdirectory","openApiOperationId":"getPublicDirectory","summary":"Returns a organization directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/getpublicdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/searchdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"directory","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1organizationDirectories~1{tenantId}~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDirectories/{tenantId}/search/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/search/{id}","href":"organization-directories/searchdirectory","openApiOperationId":"searchDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/searchdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/search/{id}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/deleteorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/deleteorganizationdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will delete a organization directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrganizationDirectory","name":"Returns a organization directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a organization directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization directory to delete.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organizationDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/{id}","href":"organization-directories/deleteorganizationdirectory","openApiOperationId":"deleteOrganizationDirectory","summary":"Returns a organization directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization directory could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/deleteorganizationdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getorganizationdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will look up a organization directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationDirectory","name":"Returns a organization directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a organization directory by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization directory to return.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationDirectories/{tenantId}/{id}","href":"organization-directories/getorganizationdirectory","openApiOperationId":"getOrganizationDirectory","summary":"Returns a organization directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/getorganizationdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Partially updates a organization directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/patchorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/patchorganizationdirectory","metadata":{"seo":{"title":"Partially updates a organization directory with the specified ID.","description":"This method will patch an existing organization directory with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrganizationDirectory","name":"Partially updates a organization directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a organization directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing organization directory with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization directory to patch.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organizationDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/{id}","href":"organization-directories/patchorganizationdirectory","openApiOperationId":"patchOrganizationDirectory","summary":"Partially updates a organization directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/patchorganizationdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Updates a organization directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/updateorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/updateorganizationdirectory","metadata":{"seo":{"title":"Updates a organization directory with the specified ID.","description":"This method will update an existing organization directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganizationDirectory","name":"Updates a organization directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a organization directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing organization directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization directory to update.","required":true}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/put/requestBody","description":"The updated organization directory that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizationDirectories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDirectories/{tenantId}/{id}","href":"organization-directories/updateorganizationdirectory","openApiOperationId":"updateOrganizationDirectory","summary":"Updates a organization directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization directory was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}},"schemaId":"components/schemas/OrganizationDirectory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization directory supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDirectories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDirectory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDirectory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-directories/updateorganizationdirectory"}],"panels":[]}]},"httpPath":"/organizationDirectories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Organization Directories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Directories","showPageActions":true},{"nodeType":"markdoc","content":"Organization Directories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizationDirectories/{tenantId}","summary":"Gets all of the organization directories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-directories/listorganizationdirectories","deprecated":false},{"title":"/organizationDirectories/{tenantId}","summary":"Creates a new organization directory record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-directories/createorganizationdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-directories/executebatchoperations","deprecated":false},{"title":"/organizationDirectories/{tenantId}/public/entry/{id}/{entryId}","summary":"Gets an entry in the directory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-directories/getdirectoryentry","deprecated":false},{"title":"/organizationDirectories/{tenantId}/public/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-directories/searchpublicdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","summary":"Sends a message to an entry in the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-directories/senddirectorymessage","deprecated":false},{"title":"/organizationDirectories/{tenantId}/public/{id}","summary":"Returns a organization directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-directories/getpublicdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-directories/searchdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/{id}","summary":"Returns a organization directory from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-directories/deleteorganizationdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/{id}","summary":"Returns a organization directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-directories/getorganizationdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/{id}","summary":"Partially updates a organization directory with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-directories/patchorganizationdirectory","deprecated":false},{"title":"/organizationDirectories/{tenantId}/{id}","summary":"Updates a organization directory with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-directories/updateorganizationdirectory","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Duplicates","link":"/apis/rolodex/rolodex-v1/organization-duplicates","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates","items":[{"label":"Gets all of the organization duplicates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/listorganizationduplicates","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/listorganizationduplicates","metadata":{"seo":{"title":"Gets all of the organization duplicates in the system.","description":"This method will scan all organization duplicates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrganizationDuplicates","name":"Gets all of the organization duplicates in the system.","isWebhook":false,"pointer":"/paths/~1organizationDuplicates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the organization duplicates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all organization duplicates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDuplicates/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/organizationDuplicates/{tenantId}","href":"organization-duplicates/listorganizationduplicates","openApiOperationId":"listOrganizationDuplicates","summary":"Gets all of the organization duplicates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization duplicateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}},"schemaId":"schema_613","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_613","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-duplicates/listorganizationduplicates"}],"panels":[]}]},"httpPath":"/organizationDuplicates/{tenantId}"},{"label":"Search for potential duplicates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/duplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/duplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"duplicateCheck","name":"Search for potential duplicates","isWebhook":false,"pointer":"/paths/~1organizationDuplicates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for potential duplicates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicateCheck"}},"schemaId":"components/schemas/OrganizationDuplicateCheck","pointer":"/paths/~1organizationDuplicates~1{tenantId}/post/requestBody","description":"The data you would like to try to check for duplicates"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationDuplicates/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicateCheck"}},"responseCodes":["200","400","429","500"],"pointer":"/organizationDuplicates/{tenantId}","href":"organization-duplicates/duplicatecheck","openApiOperationId":"duplicateCheck","summary":"Search for potential duplicates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationDuplicateCheck","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicateCheck"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Potential duplicates were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_614"}},"schemaId":"schema_614","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_614","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_614"}}},{"code":"400"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-duplicates/duplicatecheck"}],"panels":[]}]},"httpPath":"/organizationDuplicates/{tenantId}"},{"label":"Returns a organization duplicate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/getorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/getorganizationduplicate","metadata":{"seo":{"title":"Returns a organization duplicate from the system by its ID.","description":"This method will look up a organization duplicate by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationDuplicate","name":"Returns a organization duplicate from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization duplicate from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a organization duplicate by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization duplicate to return.","required":true}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationDuplicates/{tenantId}/{id}","href":"organization-duplicates/getorganizationduplicate","openApiOperationId":"getOrganizationDuplicate","summary":"Returns a organization duplicate from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization duplicate was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"schemaId":"components/schemas/OrganizationDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-duplicates/getorganizationduplicate"}],"panels":[]}]},"httpPath":"/organizationDuplicates/{tenantId}/{id}"},{"label":"Partially updates a organization duplicate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/patchorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/patchorganizationduplicate","metadata":{"seo":{"title":"Partially updates a organization duplicate with the specified ID.","description":"This method will patch an existing organization duplicate with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrganizationDuplicate","name":"Partially updates a organization duplicate with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a organization duplicate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing organization duplicate with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization duplicate to patch.","required":true}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organizationDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDuplicates/{tenantId}/{id}","href":"organization-duplicates/patchorganizationduplicate","openApiOperationId":"patchOrganizationDuplicate","summary":"Partially updates a organization duplicate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization duplicate was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"schemaId":"components/schemas/OrganizationDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization duplicate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-duplicates/patchorganizationduplicate"}],"panels":[]}]},"httpPath":"/organizationDuplicates/{tenantId}/{id}"},{"label":"Updates a organization duplicate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/updateorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/updateorganizationduplicate","metadata":{"seo":{"title":"Updates a organization duplicate with the specified ID.","description":"This method will update an existing organization duplicate with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganizationDuplicate","name":"Updates a organization duplicate with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a organization duplicate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing organization duplicate with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization duplicate to update.","required":true}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"schemaId":"components/schemas/OrganizationDuplicate","pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/put/requestBody","description":"The updated organization duplicate that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizationDuplicates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizationDuplicates/{tenantId}/{id}","href":"organization-duplicates/updateorganizationduplicate","openApiOperationId":"updateOrganizationDuplicate","summary":"Updates a organization duplicate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationDuplicate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization duplicate was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}},"schemaId":"components/schemas/OrganizationDuplicate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization duplicate supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization duplicate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization duplicate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization duplicate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationDuplicates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDuplicate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDuplicate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-duplicates/updateorganizationduplicate"}],"panels":[]}]},"httpPath":"/organizationDuplicates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Organization Duplicates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Duplicates","showPageActions":true},{"nodeType":"markdoc","content":"Organization Duplicates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizationDuplicates/{tenantId}","summary":"Gets all of the organization duplicates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-duplicates/listorganizationduplicates","deprecated":false},{"title":"/organizationDuplicates/{tenantId}","summary":"Search for potential duplicates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-duplicates/duplicatecheck","deprecated":false},{"title":"/organizationDuplicates/{tenantId}/{id}","summary":"Returns a organization duplicate from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-duplicates/getorganizationduplicate","deprecated":false},{"title":"/organizationDuplicates/{tenantId}/{id}","summary":"Partially updates a organization duplicate with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-duplicates/patchorganizationduplicate","deprecated":false},{"title":"/organizationDuplicates/{tenantId}/{id}","summary":"Updates a organization duplicate with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-duplicates/updateorganizationduplicate","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization Types","link":"/apis/rolodex/rolodex-v1/organization-types","routeSlug":"/apis/rolodex/rolodex-v1/organization-types","items":[{"label":"Gets all of the organization types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/listorganizationtypes","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/listorganizationtypes","metadata":{"seo":{"title":"Gets all of the organization types in the system.","description":"This method will scan all organization types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrganizationTypes","name":"Gets all of the organization types in the system.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the organization types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all organization types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1organizationTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationTypes/{tenantId}","href":"organization-types/listorganizationtypes","openApiOperationId":"listOrganizationTypes","summary":"Gets all of the organization types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/listorganizationtypes"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}"},{"label":"Creates a new organization type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/createorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/createorganizationtype","metadata":{"seo":{"title":"Creates a new organization type record that does not already exist.","description":"This method will auto-generate an ID and create a new organization type. If an ID is specified for the organization type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrganizationType","name":"Creates a new organization type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new organization type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new organization type. If an ID is specified for the organization type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","pointer":"/paths/~1organizationTypes~1{tenantId}/post/requestBody","description":"The organization type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/organizationTypes/{tenantId}","href":"organization-types/createorganizationtype","openApiOperationId":"createOrganizationType","summary":"Creates a new organization type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/createorganizationtype"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1organizationTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizationTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationTypes/{tenantId}/batch","href":"organization-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}/batch"},{"label":"Returns a organization type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/deleteorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/deleteorganizationtype","metadata":{"seo":{"title":"Returns a organization type from the system by its ID.","description":"This method will delete a organization type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrganizationType","name":"Returns a organization type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a organization type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization type to delete.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organizationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/organizationTypes/{tenantId}/{id}","href":"organization-types/deleteorganizationtype","openApiOperationId":"deleteOrganizationType","summary":"Returns a organization type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/deleteorganizationtype"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Returns a organization type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/getorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/getorganizationtype","metadata":{"seo":{"title":"Returns a organization type from the system by its ID.","description":"This method will look up a organization type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationType","name":"Returns a organization type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a organization type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization type to return.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizationTypes/{tenantId}/{id}","href":"organization-types/getorganizationtype","openApiOperationId":"getOrganizationType","summary":"Returns a organization type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/getorganizationtype"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Partially updates a organization type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/patchorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/patchorganizationtype","metadata":{"seo":{"title":"Partially updates a organization type with the specified ID.","description":"This method will patch an existing organization type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrganizationType","name":"Partially updates a organization type with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a organization type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing organization type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization type to patch.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organizationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/organizationTypes/{tenantId}/{id}","href":"organization-types/patchorganizationtype","openApiOperationId":"patchOrganizationType","summary":"Partially updates a organization type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/patchorganizationtype"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Updates a organization type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/updateorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/updateorganizationtype","metadata":{"seo":{"title":"Updates a organization type with the specified ID.","description":"This method will update an existing organization type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganizationType","name":"Updates a organization type with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a organization type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing organization type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization type to update.","required":true}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated organization type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizationTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/organizationTypes/{tenantId}/{id}","href":"organization-types/updateorganizationtype","openApiOperationId":"updateOrganizationType","summary":"Updates a organization type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}},"schemaId":"components/schemas/OrganizationType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizationTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization-types/updateorganizationtype"}],"panels":[]}]},"httpPath":"/organizationTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Organization Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization Types","showPageActions":true},{"nodeType":"markdoc","content":"Organization Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizationTypes/{tenantId}","summary":"Gets all of the organization types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-types/listorganizationtypes","deprecated":false},{"title":"/organizationTypes/{tenantId}","summary":"Creates a new organization type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-types/createorganizationtype","deprecated":false},{"title":"/organizationTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organization-types/executebatchoperations","deprecated":false},{"title":"/organizationTypes/{tenantId}/{id}","summary":"Returns a organization type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organization-types/deleteorganizationtype","deprecated":false},{"title":"/organizationTypes/{tenantId}/{id}","summary":"Returns a organization type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization-types/getorganizationtype","deprecated":false},{"title":"/organizationTypes/{tenantId}/{id}","summary":"Partially updates a organization type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organization-types/patchorganizationtype","deprecated":false},{"title":"/organizationTypes/{tenantId}/{id}","summary":"Updates a organization type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organization-types/updateorganizationtype","deprecated":false}]}]}]}]}},{"type":"group","label":"Organizations","link":"/apis/rolodex/rolodex-v1/organizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations","items":[{"label":"Creates a new organization record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/createorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/createorganization","metadata":{"seo":{"title":"Creates a new organization record that does not already exist.","description":"This method will auto-generate an ID and create a new organization. If an ID is specified for the organization, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrganization","name":"Creates a new organization record that does not already exist.","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new organization record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new organization. If an ID is specified for the organization, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","pointer":"/paths/~1organizations~1{tenantId}/post/requestBody","description":"The organization that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Organization"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}","href":"organizations/createorganization","openApiOperationId":"createOrganization","summary":"Creates a new organization record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Organization"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/createorganization"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1organizations~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/batch","href":"organizations/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/executebatchoperations"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/batch"},{"label":"Get all descendent organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getdescendents","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getdescendents","metadata":{"seo":{"title":"Get all descendent organizations","description":"Recursively finds all descendents to an organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDescendents","name":"Get all descendent organizations","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1descendents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all descendent organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Recursively finds all descendents to an organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The organization ID","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1descendents~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields"}],"pointer":"/paths/~1organizations~1{tenantId}~1descendents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/descendents/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/descendents/{id}","href":"organizations/getdescendents","openApiOperationId":"getDescendents","summary":"Get all descendent organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1descendents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getdescendents"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/descendents/{id}"},{"label":"Returns the organization matching the specified domain_name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getorganizationbydomainname","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getorganizationbydomainname","metadata":{"seo":{"title":"Returns the organization matching the specified domain_name","description":"Returns the organization matching the specified domain_name"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationByDomainName","name":"Returns the organization matching the specified domain_name","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1domain_name~1{domain_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the organization matching the specified domain_name","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":"Returns the organization matching the specified domain_name"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"domain_name","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1domain_name~1{domain_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1organizations~1{tenantId}~1domain_name~1{domain_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/domain_name/{domain_name}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"domain_name","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/domain_name/{domain_name}","href":"organizations/getorganizationbydomainname","openApiOperationId":"getOrganizationByDomainName","summary":"Returns the organization matching the specified domain_name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1domain_name~1{domain_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getorganizationbydomainname"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/domain_name/{domain_name}"},{"label":"Finds all conflicting fields for organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getfieldconflicts","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getfieldconflicts","metadata":{"seo":{"title":"Finds all conflicting fields for organizations","description":"This method will load organizations, compare them, and return all fields that are in conflict"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFieldConflicts","name":"Finds all conflicting fields for organizations","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1getFieldConflicts~1{ids}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finds all conflicting fields for organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will load organizations, compare them, and return all fields that are in conflict"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"ids","in":"path","schemaId":"schema_591","description":"Comma-separated listo fIDS","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1getFieldConflicts~1{ids}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/getFieldConflicts/{ids}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"ids","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/getFieldConflicts/{ids}","href":"organizations/getfieldconflicts","openApiOperationId":"getFieldConflicts","summary":"Finds all conflicting fields for organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldConflictReport"}},"schemaId":"components/schemas/FieldConflictReport","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1getFieldConflicts~1{ids}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FieldConflictReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldConflictReport"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getfieldconflicts"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/getFieldConflicts/{ids}"},{"label":"Returns a list of records with the specified parent_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/listorganizationsbyparentorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/organizations/listorganizationsbyparentorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_organization_id","description":"Returns a list of records with the specified parent_organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrganizationsByParentOrganizationId","name":"Returns a list of records with the specified parent_organization_id","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1parentOrganization~1{parent_organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified parent_organization_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":"Returns a list of records with the specified parent_organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"parent_organization_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent_organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1parentOrganization~1{parent_organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1organizations~1{tenantId}~1parentOrganization~1{parent_organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/parentOrganization/{parent_organization_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"parent_organization_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/parentOrganization/{parent_organization_id}","href":"organizations/listorganizationsbyparentorganizationid","openApiOperationId":"listOrganizationsByParentOrganizationId","summary":"Returns a list of records with the specified parent_organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationsResponse"}},"schemaId":"components/schemas/ListOrganizationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1parentOrganization~1{parent_organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrganizationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrganizationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/listorganizationsbyparentorganizationid"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/parentOrganization/{parent_organization_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/previewcontactrolecomplianceemail","routeSlug":"/apis/rolodex/rolodex-v1/organizations/previewcontactrolecomplianceemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewContactRoleComplianceEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1previewContactRoleComplianceEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1previewContactRoleComplianceEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewCRCEmailRequest"}},"schemaId":"components/schemas/PreviewCRCEmailRequest","pointer":"/paths/~1organizations~1{tenantId}~1previewContactRoleComplianceEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{tenantId}/previewContactRoleComplianceEmail","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewCRCEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/previewContactRoleComplianceEmail","href":"organizations/previewcontactrolecomplianceemail","openApiOperationId":"previewContactRoleComplianceEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewCRCEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewCRCEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1previewContactRoleComplianceEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/previewcontactrolecomplianceemail"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/previewContactRoleComplianceEmail"},{"label":"Get publicly available information for an org","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/publicreadorg","routeSlug":"/apis/rolodex/rolodex-v1/organizations/publicreadorg","metadata":{"seo":{"title":"Get publicly available information for an org","description":"This method will return the publicly accessible information for an org. It is used on the portal to make authenticated requests to users who are not yet tied to the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"publicReadOrg","name":"Get publicly available information for an org","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get publicly available information for an org","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will return the publicly accessible information for an org.  It is used on the portal to make authenticated requests to users who are not yet tied to the organization"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The id of the organization being accessed","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/public/{id}","href":"organizations/publicreadorg","openApiOperationId":"publicReadOrg","summary":"Get publicly available information for an org"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Organization was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The parameters you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to process requests based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/publicreadorg"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/public/{id}"},{"label":"Re-runs compliance for all organizations in the system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/reprocesscompliance","routeSlug":"/apis/rolodex/rolodex-v1/organizations/reprocesscompliance","metadata":{"seo":{"title":"Re-runs compliance for all organizations in the system","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprocessCompliance","name":"Re-runs compliance for all organizations in the system","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1reprocessCompliance/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Re-runs compliance for all organizations in the system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Given a set of expiration options, allows for the calculation of an expiration date"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1reprocessCompliance/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{tenantId}/reprocessCompliance","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/reprocessCompliance","href":"organizations/reprocesscompliance","openApiOperationId":"reprocessCompliance","summary":"Re-runs compliance for all organizations in the system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Date was calculated successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The members supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The members could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1reprocessCompliance/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/reprocesscompliance"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/reprocessCompliance"},{"label":"Searches for organizations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/searchfororganizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/searchfororganizations","metadata":{"seo":{"title":"Searches for organizations using predefined parameters","description":"Searches for organizations using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForOrganizations","name":"Searches for organizations using predefined parameters","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for organizations using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for organizations using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_591","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1organizations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchParameters"}},"schemaId":"components/schemas/OrganizationSearchParameters","pointer":"/paths/~1organizations~1{tenantId}~1search/post/requestBody","description":"The organization that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organizations/{tenantId}/search","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}/search","href":"organizations/searchfororganizations","openApiOperationId":"searchForOrganizations","summary":"Searches for organizations using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrganizationSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedOrganizationSearchResults"}},"schemaId":"components/schemas/PagedOrganizationSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedOrganizationSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedOrganizationSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/searchfororganizations"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/search"},{"label":"Looks up a social profile and returns what is found to the user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getsocialprofile","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getsocialprofile","metadata":{"seo":{"title":"Looks up a social profile and returns what is found to the user","description":"This method will make a call and parse/return the results"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSocialProfile","name":"Looks up a social profile and returns what is found to the user","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1socialProfile~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Looks up a social profile and returns what is found to the user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will make a call and parse/return the results"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed","required":true},{"name":"domain","in":"path","schemaId":"schema_591","description":"The domain to look up","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1socialProfile~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/socialProfile/{domain}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"domain","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/socialProfile/{domain}","href":"organizations/getsocialprofile","openApiOperationId":"getSocialProfile","summary":"Looks up a social profile and returns what is found to the user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The social profile was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSocialProfile"}},"schemaId":"components/schemas/OrganizationSocialProfile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The social profile was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve counts based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1socialProfile~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationSocialProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSocialProfile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getsocialprofile"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/socialProfile/{domain}"},{"label":"Returns a organization from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/deleteorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/deleteorganization","metadata":{"seo":{"title":"Returns a organization from the system by its ID.","description":"This method will delete a organization with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrganization","name":"Returns a organization from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a organization with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization to delete.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organizations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}/{id}","href":"organizations/deleteorganization","openApiOperationId":"deleteOrganization","summary":"Returns a organization from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/deleteorganization"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Returns a organization from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getorganization","metadata":{"seo":{"title":"Returns a organization from the system by its ID.","description":"This method will look up a organization by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganization","name":"Returns a organization from the system by its ID.","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a organization from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a organization by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization to return.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organizations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organizations/{tenantId}/{id}","href":"organizations/getorganization","openApiOperationId":"getOrganization","summary":"Returns a organization from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getorganization"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Partially updates a organization with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/patchorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/patchorganization","metadata":{"seo":{"title":"Partially updates a organization with the specified ID.","description":"This method will patch an existing organization with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrganization","name":"Partially updates a organization with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a organization with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing organization with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization to patch.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1organizations~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organizations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}/{id}","href":"organizations/patchorganization","openApiOperationId":"patchOrganization","summary":"Partially updates a organization with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/patchorganization"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Updates a organization with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/updateorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/updateorganization","metadata":{"seo":{"title":"Updates a organization with the specified ID.","description":"This method will update an existing organization with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrganization","name":"Updates a organization with the specified ID.","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a organization with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing organization with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization to update.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","pointer":"/paths/~1organizations~1{tenantId}~1{id}/put/requestBody","description":"The updated organization that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Organization"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}/{id}","href":"organizations/updateorganization","openApiOperationId":"updateOrganization","summary":"Updates a organization with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Organization"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/updateorganization"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/mergeorganizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/mergeorganizations","metadata":{"seo":{"title":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","description":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mergeOrganizations","name":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","isWebhook":false,"pointer":"/paths/~1organizations~1{tenantId}~1{id}~1merge/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the organization to merge.","required":true}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}~1merge/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"schemaId":"components/schemas/MergeContact","pointer":"/paths/~1organizations~1{tenantId}~1{id}~1merge/put/requestBody","description":"The updated organization to be merged."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organizations/{tenantId}/{id}/merge","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/organizations/{tenantId}/{id}/merge","href":"organizations/mergeorganizations","openApiOperationId":"mergeOrganizations","summary":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MergeContact","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MergeContact"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}},"schemaId":"components/schemas/Organization","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The organization supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The organization could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The organization could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to merge organization based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1organizations~1{tenantId}~1{id}~1merge/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organization"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/mergeorganizations"}],"panels":[]}]},"httpPath":"/organizations/{tenantId}/{id}/merge"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":"Organizations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organizations/{tenantId}","summary":"Creates a new organization record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/createorganization","deprecated":false},{"title":"/organizations/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/executebatchoperations","deprecated":false},{"title":"/organizations/{tenantId}/descendents/{id}","summary":"Get all descendent organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getdescendents","deprecated":false},{"title":"/organizations/{tenantId}/domain_name/{domain_name}","summary":"Returns the organization matching the specified domain_name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getorganizationbydomainname","deprecated":false},{"title":"/organizations/{tenantId}/getFieldConflicts/{ids}","summary":"Finds all conflicting fields for organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getfieldconflicts","deprecated":false},{"title":"/organizations/{tenantId}/parentOrganization/{parent_organization_id}","summary":"Returns a list of records with the specified parent_organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/listorganizationsbyparentorganizationid","deprecated":false},{"title":"/organizations/{tenantId}/previewContactRoleComplianceEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/previewcontactrolecomplianceemail","deprecated":false},{"title":"/organizations/{tenantId}/public/{id}","summary":"Get publicly available information for an org","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/publicreadorg","deprecated":false},{"title":"/organizations/{tenantId}/reprocessCompliance","summary":"Re-runs compliance for all organizations in the system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/reprocesscompliance","deprecated":false},{"title":"/organizations/{tenantId}/search","summary":"Searches for organizations using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/searchfororganizations","deprecated":false},{"title":"/organizations/{tenantId}/socialProfile/{domain}","summary":"Looks up a social profile and returns what is found to the user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getsocialprofile","deprecated":false},{"title":"/organizations/{tenantId}/{id}","summary":"Returns a organization from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/organizations/deleteorganization","deprecated":false},{"title":"/organizations/{tenantId}/{id}","summary":"Returns a organization from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getorganization","deprecated":false},{"title":"/organizations/{tenantId}/{id}","summary":"Partially updates a organization with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organizations/patchorganization","deprecated":false},{"title":"/organizations/{tenantId}/{id}","summary":"Updates a organization with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organizations/updateorganization","deprecated":false},{"title":"/organizations/{tenantId}/{id}/merge","summary":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","prefix":{"name":"put","color":"put"},"badges":[],"link":"/organizations/mergeorganizations","deprecated":false}]}]}]}]}},{"type":"group","label":"Phone Number Types","link":"/apis/rolodex/rolodex-v1/phone-number-types","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types","items":[{"label":"Gets all of the phone number types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/listphonenumbertypes","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/listphonenumbertypes","metadata":{"seo":{"title":"Gets all of the phone number types in the system.","description":"This method will scan all phone number types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPhoneNumberTypes","name":"Gets all of the phone number types in the system.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the phone number types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all phone number types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/phoneNumberTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/phoneNumberTypes/{tenantId}","href":"phone-number-types/listphonenumbertypes","openApiOperationId":"listPhoneNumberTypes","summary":"Gets all of the phone number types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}},"schemaId":"schema_617","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_617","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/listphonenumbertypes"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}"},{"label":"Creates a new phone number type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/createphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/createphonenumbertype","metadata":{"seo":{"title":"Creates a new phone number type record that does not already exist.","description":"This method will auto-generate an ID and create a new phone number type. If an ID is specified for the phone number type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPhoneNumberType","name":"Creates a new phone number type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new phone number type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new phone number type. If an ID is specified for the phone number type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","pointer":"/paths/~1phoneNumberTypes~1{tenantId}/post/requestBody","description":"The phone number type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/phoneNumberTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/phoneNumberTypes/{tenantId}","href":"phone-number-types/createphonenumbertype","openApiOperationId":"createPhoneNumberType","summary":"Creates a new phone number type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The phone number type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The phone number type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add phone number type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/createphonenumbertype"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}"},{"label":"Returns a phone number type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/deletephonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/deletephonenumbertype","metadata":{"seo":{"title":"Returns a phone number type from the system by its ID.","description":"This method will delete a phone number type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePhoneNumberType","name":"Returns a phone number type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a phone number type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a phone number type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the phone number type to delete.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/phoneNumberTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/phoneNumberTypes/{tenantId}/{id}","href":"phone-number-types/deletephonenumbertype","openApiOperationId":"deletePhoneNumberType","summary":"Returns a phone number type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The phone number type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The phone number type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete phone number type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/deletephonenumbertype"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Returns a phone number type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/getphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/getphonenumbertype","metadata":{"seo":{"title":"Returns a phone number type from the system by its ID.","description":"This method will look up a phone number type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPhoneNumberType","name":"Returns a phone number type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a phone number type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a phone number type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the phone number type to return.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/phoneNumberTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/phoneNumberTypes/{tenantId}/{id}","href":"phone-number-types/getphonenumbertype","openApiOperationId":"getPhoneNumberType","summary":"Returns a phone number type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The phone number type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve phone number type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/getphonenumbertype"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Partially updates a phone number type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/patchphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/patchphonenumbertype","metadata":{"seo":{"title":"Partially updates a phone number type with the specified ID.","description":"This method will patch an existing phone number type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPhoneNumberType","name":"Partially updates a phone number type with the specified ID.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a phone number type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing phone number type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the phone number type to patch.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/phoneNumberTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/phoneNumberTypes/{tenantId}/{id}","href":"phone-number-types/patchphonenumbertype","openApiOperationId":"patchPhoneNumberType","summary":"Partially updates a phone number type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The phone number type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The phone number type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve phone number type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/patchphonenumbertype"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Updates a phone number type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/updatephonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/updatephonenumbertype","metadata":{"seo":{"title":"Updates a phone number type with the specified ID.","description":"This method will update an existing phone number type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePhoneNumberType","name":"Updates a phone number type with the specified ID.","isWebhook":false,"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a phone number type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing phone number type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the phone number type to update.","required":true}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated phone number type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/phoneNumberTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/phoneNumberTypes/{tenantId}/{id}","href":"phone-number-types/updatephonenumbertype","openApiOperationId":"updatePhoneNumberType","summary":"Updates a phone number type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The phone number type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}},"schemaId":"components/schemas/PhoneNumberType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The phone number type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The phone number type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The phone number type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve phone number type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1phoneNumberTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhoneNumberType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneNumberType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-number-types/updatephonenumbertype"}],"panels":[]}]},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Phone Number Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone Number Types","showPageActions":true},{"nodeType":"markdoc","content":"Phone Number Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/phoneNumberTypes/{tenantId}","summary":"Gets all of the phone number types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/phone-number-types/listphonenumbertypes","deprecated":false},{"title":"/phoneNumberTypes/{tenantId}","summary":"Creates a new phone number type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone-number-types/createphonenumbertype","deprecated":false},{"title":"/phoneNumberTypes/{tenantId}/{id}","summary":"Returns a phone number type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/phone-number-types/deletephonenumbertype","deprecated":false},{"title":"/phoneNumberTypes/{tenantId}/{id}","summary":"Returns a phone number type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/phone-number-types/getphonenumbertype","deprecated":false},{"title":"/phoneNumberTypes/{tenantId}/{id}","summary":"Partially updates a phone number type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/phone-number-types/patchphonenumbertype","deprecated":false},{"title":"/phoneNumberTypes/{tenantId}/{id}","summary":"Updates a phone number type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/phone-number-types/updatephonenumbertype","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/rolodex/rolodex-v1/query-definitions","routeSlug":"/apis/rolodex/rolodex-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/rolodex/rolodex-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryDefinitions","name":"Returns a list of records","isWebhook":false,"pointer":"/paths/~1queryDefinitions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queryDefinitions/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queryDefinitions/{tenantId}","href":"query-definitions/getquerydefinitions","openApiOperationId":"getQueryDefinitions","summary":"Returns a list of records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}},"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-definitions/getquerydefinitions"}],"panels":[]}]},"httpPath":"/queryDefinitions/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Query Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Definitions","showPageActions":true},{"nodeType":"markdoc","content":"Query Definitions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queryDefinitions/{tenantId}","summary":"Returns a list of records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query-definitions/getquerydefinitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Region Configurations","link":"/apis/rolodex/rolodex-v1/region-configurations","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations","items":[{"label":"Returns a region configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/deleteregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/deleteregionconfiguration","metadata":{"seo":{"title":"Returns a region configuration from the system by its ID.","description":"This method will delete a region configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRegionConfiguration","name":"Returns a region configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1regionConfigurations~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a region configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a region configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/regionConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regionConfigurations/{tenantId}","href":"region-configurations/deleteregionconfiguration","openApiOperationId":"deleteRegionConfiguration","summary":"Returns a region configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region configuration was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region configuration could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete region configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-configurations/deleteregionconfiguration"}],"panels":[]}]},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Returns a region configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/getregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/getregionconfiguration","metadata":{"seo":{"title":"Returns a region configuration from the system by its ID.","description":"This method will look up a region configuration by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRegionConfiguration","name":"Returns a region configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1regionConfigurations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a region configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a region configuration by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regionConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/regionConfigurations/{tenantId}","href":"region-configurations/getregionconfiguration","openApiOperationId":"getRegionConfiguration","summary":"Returns a region configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region configuration was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-configurations/getregionconfiguration"}],"panels":[]}]},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Partially updates a region configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/patchregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/patchregionconfiguration","metadata":{"seo":{"title":"Partially updates a region configuration with the specified ID.","description":"This method will patch an existing region configuration with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRegionConfiguration","name":"Partially updates a region configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1regionConfigurations~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a region configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing region configuration with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1regionConfigurations~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/regionConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regionConfigurations/{tenantId}","href":"region-configurations/patchregionconfiguration","openApiOperationId":"patchRegionConfiguration","summary":"Partially updates a region configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region configuration was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-configurations/patchregionconfiguration"}],"panels":[]}]},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Creates a new region configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/createregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/createregionconfiguration","metadata":{"seo":{"title":"Creates a new region configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new region configuration. If an ID is specified for the region configuration, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRegionConfiguration","name":"Creates a new region configuration record that does not already exist.","isWebhook":false,"pointer":"/paths/~1regionConfigurations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new region configuration record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new region configuration. If an ID is specified for the region configuration, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","pointer":"/paths/~1regionConfigurations~1{tenantId}/post/requestBody","description":"The region configuration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/regionConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/regionConfigurations/{tenantId}","href":"region-configurations/createregionconfiguration","openApiOperationId":"createRegionConfiguration","summary":"Creates a new region configuration record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region configuration was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The region configuration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add region configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-configurations/createregionconfiguration"}],"panels":[]}]},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Updates a region configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/updateregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/updateregionconfiguration","metadata":{"seo":{"title":"Updates a region configuration with the specified ID.","description":"This method will update an existing region configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRegionConfiguration","name":"Updates a region configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1regionConfigurations~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a region configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing region configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","pointer":"/paths/~1regionConfigurations~1{tenantId}/put/requestBody","description":"The updated region configuration that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/regionConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regionConfigurations/{tenantId}","href":"region-configurations/updateregionconfiguration","openApiOperationId":"updateRegionConfiguration","summary":"Updates a region configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region configuration was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}},"schemaId":"components/schemas/RegionConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The region configuration supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regionConfigurations~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-configurations/updateregionconfiguration"}],"panels":[]}]},"httpPath":"/regionConfigurations/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Region Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Region Configurations","showPageActions":true},{"nodeType":"markdoc","content":"Region Configurations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/regionConfigurations/{tenantId}","summary":"Returns a region configuration from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/region-configurations/deleteregionconfiguration","deprecated":false},{"title":"/regionConfigurations/{tenantId}","summary":"Returns a region configuration from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/region-configurations/getregionconfiguration","deprecated":false},{"title":"/regionConfigurations/{tenantId}","summary":"Partially updates a region configuration with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/region-configurations/patchregionconfiguration","deprecated":false},{"title":"/regionConfigurations/{tenantId}","summary":"Creates a new region configuration record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/region-configurations/createregionconfiguration","deprecated":false},{"title":"/regionConfigurations/{tenantId}","summary":"Updates a region configuration with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/region-configurations/updateregionconfiguration","deprecated":false}]}]}]}]}},{"type":"group","label":"Regions","link":"/apis/rolodex/rolodex-v1/regions","routeSlug":"/apis/rolodex/rolodex-v1/regions","items":[{"label":"Gets all of the regions in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/listregions","routeSlug":"/apis/rolodex/rolodex-v1/regions/listregions","metadata":{"seo":{"title":"Gets all of the regions in the system.","description":"This method will scan all regions and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegions","name":"Gets all of the regions in the system.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the regions in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all regions and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regions~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1regions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regions/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/regions/{tenantId}","href":"regions/listregions","openApiOperationId":"listRegions","summary":"Gets all of the regions in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The regionswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_618"}},"schemaId":"schema_618","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_618","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_618"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/listregions"}],"panels":[]}]},"httpPath":"/regions/{tenantId}"},{"label":"Creates a new region record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/createregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/createregion","metadata":{"seo":{"title":"Creates a new region record that does not already exist.","description":"This method will auto-generate an ID and create a new region. If an ID is specified for the region, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRegion","name":"Creates a new region record that does not already exist.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new region record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new region. If an ID is specified for the region, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regions~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","pointer":"/paths/~1regions~1{tenantId}/post/requestBody","description":"The region that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/regions/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Region"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regions/{tenantId}","href":"regions/createregion","openApiOperationId":"createRegion","summary":"Creates a new region record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Region"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The region you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/createregion"}],"panels":[]}]},"httpPath":"/regions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/regions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1regions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/regions/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/regions/{tenantId}/batch","href":"regions/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/executebatchoperations"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/batch"},{"label":"Recalculate Region Assignments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/recalculateregionassignments","routeSlug":"/apis/rolodex/rolodex-v1/regions/recalculateregionassignments","metadata":{"seo":{"title":"Recalculate Region Assignments","description":"Goes through and recalculates all region assignments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recalculateRegionAssignments","name":"Recalculate Region Assignments","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1recalculate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recalculate Region Assignments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Goes through and recalculates all region assignments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1recalculate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/regions/{tenantId}/recalculate","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/regions/{tenantId}/recalculate","href":"regions/recalculateregionassignments","openApiOperationId":"recalculateRegionAssignments","summary":"Recalculate Region Assignments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1recalculate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/recalculateregionassignments"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/recalculate"},{"label":"Returns a region from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/deleteregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/deleteregion","metadata":{"seo":{"title":"Returns a region from the system by its ID.","description":"This method will delete a region with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRegion","name":"Returns a region from the system by its ID.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a region from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a region with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the region to delete.","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/regions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regions/{tenantId}/{id}","href":"regions/deleteregion","openApiOperationId":"deleteRegion","summary":"Returns a region from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/deleteregion"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Returns a region from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/getregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/getregion","metadata":{"seo":{"title":"Returns a region from the system by its ID.","description":"This method will look up a region by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRegion","name":"Returns a region from the system by its ID.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a region from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a region by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the region to return.","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/regions/{tenantId}/{id}","href":"regions/getregion","openApiOperationId":"getRegion","summary":"Returns a region from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/getregion"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Partially updates a region with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/patchregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/patchregion","metadata":{"seo":{"title":"Partially updates a region with the specified ID.","description":"This method will patch an existing region with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRegion","name":"Partially updates a region with the specified ID.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a region with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing region with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the region to patch.","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1regions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/regions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regions/{tenantId}/{id}","href":"regions/patchregion","openApiOperationId":"patchRegion","summary":"Partially updates a region with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/patchregion"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Updates a region with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/updateregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/updateregion","metadata":{"seo":{"title":"Updates a region with the specified ID.","description":"This method will update an existing region with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRegion","name":"Updates a region with the specified ID.","isWebhook":false,"pointer":"/paths/~1regions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a region with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing region with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the region to update.","required":true}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","pointer":"/paths/~1regions~1{tenantId}~1{id}/put/requestBody","description":"The updated region that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/regions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Region"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/regions/{tenantId}/{id}","href":"regions/updateregion","openApiOperationId":"updateRegion","summary":"Updates a region with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Region"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}},"schemaId":"components/schemas/Region","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The region supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The region could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The region could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve region based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1regions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Region","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Region"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/regions/updateregion"}],"panels":[]}]},"httpPath":"/regions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Regions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regions","showPageActions":true},{"nodeType":"markdoc","content":"Regions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/regions/{tenantId}","summary":"Gets all of the regions in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/regions/listregions","deprecated":false},{"title":"/regions/{tenantId}","summary":"Creates a new region record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regions/createregion","deprecated":false},{"title":"/regions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regions/executebatchoperations","deprecated":false},{"title":"/regions/{tenantId}/recalculate","summary":"Recalculate Region Assignments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/regions/recalculateregionassignments","deprecated":false},{"title":"/regions/{tenantId}/{id}","summary":"Returns a region from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/regions/deleteregion","deprecated":false},{"title":"/regions/{tenantId}/{id}","summary":"Returns a region from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/regions/getregion","deprecated":false},{"title":"/regions/{tenantId}/{id}","summary":"Partially updates a region with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/regions/patchregion","deprecated":false},{"title":"/regions/{tenantId}/{id}","summary":"Updates a region with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/regions/updateregion","deprecated":false}]}]}]}]}},{"type":"group","label":"Relationship Types","link":"/apis/rolodex/rolodex-v1/relationship-types","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types","items":[{"label":"Gets all of the relationship types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/listrelationshiptypes","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/listrelationshiptypes","metadata":{"seo":{"title":"Gets all of the relationship types in the system.","description":"This method will scan all relationship types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRelationshipTypes","name":"Gets all of the relationship types in the system.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the relationship types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all relationship types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/relationshipTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationshipTypes/{tenantId}","href":"relationship-types/listrelationshiptypes","openApiOperationId":"listRelationshipTypes","summary":"Gets all of the relationship types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619"}},"schemaId":"schema_619","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_619","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/listrelationshiptypes"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}"},{"label":"Creates a new relationship type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/createrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/createrelationshiptype","metadata":{"seo":{"title":"Creates a new relationship type record that does not already exist.","description":"This method will auto-generate an ID and create a new relationship type. If an ID is specified for the relationship type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRelationshipType","name":"Creates a new relationship type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new relationship type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new relationship type. If an ID is specified for the relationship type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","pointer":"/paths/~1relationshipTypes~1{tenantId}/post/requestBody","description":"The relationship type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/relationshipTypes/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationshipTypes/{tenantId}","href":"relationship-types/createrelationshiptype","openApiOperationId":"createRelationshipType","summary":"Creates a new relationship type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The relationship type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/createrelationshiptype"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1relationshipTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/relationshipTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationshipTypes/{tenantId}/batch","href":"relationship-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}/batch"},{"label":"Returns a relationship type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/deleterelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/deleterelationshiptype","metadata":{"seo":{"title":"Returns a relationship type from the system by its ID.","description":"This method will delete a relationship type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRelationshipType","name":"Returns a relationship type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a relationship type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a relationship type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship type to delete.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/relationshipTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationshipTypes/{tenantId}/{id}","href":"relationship-types/deleterelationshiptype","openApiOperationId":"deleteRelationshipType","summary":"Returns a relationship type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/deleterelationshiptype"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Returns a relationship type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/getrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/getrelationshiptype","metadata":{"seo":{"title":"Returns a relationship type from the system by its ID.","description":"This method will look up a relationship type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRelationshipType","name":"Returns a relationship type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a relationship type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a relationship type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship type to return.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/relationshipTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationshipTypes/{tenantId}/{id}","href":"relationship-types/getrelationshiptype","openApiOperationId":"getRelationshipType","summary":"Returns a relationship type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/getrelationshiptype"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Partially updates a relationship type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/patchrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/patchrelationshiptype","metadata":{"seo":{"title":"Partially updates a relationship type with the specified ID.","description":"This method will patch an existing relationship type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRelationshipType","name":"Partially updates a relationship type with the specified ID.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a relationship type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing relationship type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship type to patch.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/relationshipTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationshipTypes/{tenantId}/{id}","href":"relationship-types/patchrelationshiptype","openApiOperationId":"patchRelationshipType","summary":"Partially updates a relationship type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/patchrelationshiptype"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Updates a relationship type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/updaterelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/updaterelationshiptype","metadata":{"seo":{"title":"Updates a relationship type with the specified ID.","description":"This method will update an existing relationship type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRelationshipType","name":"Updates a relationship type with the specified ID.","isWebhook":false,"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a relationship type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing relationship type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship type to update.","required":true}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated relationship type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/relationshipTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationshipTypes/{tenantId}/{id}","href":"relationship-types/updaterelationshiptype","openApiOperationId":"updateRelationshipType","summary":"Updates a relationship type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}},"schemaId":"components/schemas/RelationshipType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The relationship type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationshipTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelationshipType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelationshipType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationship-types/updaterelationshiptype"}],"panels":[]}]},"httpPath":"/relationshipTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Relationship Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Relationship Types","showPageActions":true},{"nodeType":"markdoc","content":"Relationship Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/relationshipTypes/{tenantId}","summary":"Gets all of the relationship types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationship-types/listrelationshiptypes","deprecated":false},{"title":"/relationshipTypes/{tenantId}","summary":"Creates a new relationship type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relationship-types/createrelationshiptype","deprecated":false},{"title":"/relationshipTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relationship-types/executebatchoperations","deprecated":false},{"title":"/relationshipTypes/{tenantId}/{id}","summary":"Returns a relationship type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/relationship-types/deleterelationshiptype","deprecated":false},{"title":"/relationshipTypes/{tenantId}/{id}","summary":"Returns a relationship type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationship-types/getrelationshiptype","deprecated":false},{"title":"/relationshipTypes/{tenantId}/{id}","summary":"Partially updates a relationship type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/relationship-types/patchrelationshiptype","deprecated":false},{"title":"/relationshipTypes/{tenantId}/{id}","summary":"Updates a relationship type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/relationship-types/updaterelationshiptype","deprecated":false}]}]}]}]}},{"type":"group","label":"Relationships","link":"/apis/rolodex/rolodex-v1/relationships","routeSlug":"/apis/rolodex/rolodex-v1/relationships","items":[{"label":"Creates a new relationship record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/createrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/createrelationship","metadata":{"seo":{"title":"Creates a new relationship record that does not already exist.","description":"This method will auto-generate an ID and create a new relationship. If an ID is specified for the relationship, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRelationship","name":"Creates a new relationship record that does not already exist.","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new relationship record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new relationship. If an ID is specified for the relationship, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","pointer":"/paths/~1relationships~1{tenantId}/post/requestBody","description":"The relationship that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/relationships/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Relationship"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationships/{tenantId}","href":"relationships/createrelationship","openApiOperationId":"createRelationship","summary":"Creates a new relationship record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Relationship"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The relationship you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/createrelationship"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/relationships/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1relationships~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/relationships/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationships/{tenantId}/batch","href":"relationships/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/executebatchoperations"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/batch"},{"label":"Returns a list of records with the specified left_side_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyleftsideid","routeSlug":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyleftsideid","metadata":{"seo":{"title":"Returns a list of records with the specified left_side_id","description":"Returns a list of records with the specified left_side_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRelationshipsByLeftSideId","name":"Returns a list of records with the specified left_side_id","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1leftSide~1{left_side_type}~1{left_side_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified left_side_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":"Returns a list of records with the specified left_side_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"left_side_type","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The left_side_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"left_side_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The left_side_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1leftSide~1{left_side_type}~1{left_side_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1relationships~1{tenantId}~1leftSide~1{left_side_type}~1{left_side_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/relationships/{tenantId}/leftSide/{left_side_type}/{left_side_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"left_side_type","in":"path","required":true,"schemaId":"schema_591"},{"name":"left_side_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationships/{tenantId}/leftSide/{left_side_type}/{left_side_id}","href":"relationships/listrelationshipsbyleftsideid","openApiOperationId":"listRelationshipsByLeftSideId","summary":"Returns a list of records with the specified left_side_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRelationshipsResponse"}},"schemaId":"components/schemas/ListRelationshipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1leftSide~1{left_side_type}~1{left_side_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRelationshipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRelationshipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/listrelationshipsbyleftsideid"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/leftSide/{left_side_type}/{left_side_id}"},{"label":"Returns a list of records with the specified right_side_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyrightsideid","routeSlug":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyrightsideid","metadata":{"seo":{"title":"Returns a list of records with the specified right_side_id","description":"Returns a list of records with the specified right_side_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRelationshipsByRightSideId","name":"Returns a list of records with the specified right_side_id","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1rightSide~1{right_side_type}~1{right_side_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified right_side_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":"Returns a list of records with the specified right_side_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The tenant","required":true},{"name":"right_side_type","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The right_side_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"right_side_id","in":"path","schemaId":"schema_591","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The right_side_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1rightSide~1{right_side_type}~1{right_side_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_591","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1relationships~1{tenantId}~1rightSide~1{right_side_type}~1{right_side_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/relationships/{tenantId}/rightSide/{right_side_type}/{right_side_id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"right_side_type","in":"path","required":true,"schemaId":"schema_591"},{"name":"right_side_id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationships/{tenantId}/rightSide/{right_side_type}/{right_side_id}","href":"relationships/listrelationshipsbyrightsideid","openApiOperationId":"listRelationshipsByRightSideId","summary":"Returns a list of records with the specified right_side_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRelationshipsResponse"}},"schemaId":"components/schemas/ListRelationshipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1rightSide~1{right_side_type}~1{right_side_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRelationshipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRelationshipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/listrelationshipsbyrightsideid"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/rightSide/{right_side_type}/{right_side_id}"},{"label":"Returns a relationship from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/deleterelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/deleterelationship","metadata":{"seo":{"title":"Returns a relationship from the system by its ID.","description":"This method will delete a relationship with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRelationship","name":"Returns a relationship from the system by its ID.","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a relationship from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a relationship with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship to delete.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/relationships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationships/{tenantId}/{id}","href":"relationships/deleterelationship","openApiOperationId":"deleteRelationship","summary":"Returns a relationship from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/deleterelationship"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Returns a relationship from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/getrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/getrelationship","metadata":{"seo":{"title":"Returns a relationship from the system by its ID.","description":"This method will look up a relationship by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRelationship","name":"Returns a relationship from the system by its ID.","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a relationship from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a relationship by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship to return.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/relationships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/relationships/{tenantId}/{id}","href":"relationships/getrelationship","openApiOperationId":"getRelationship","summary":"Returns a relationship from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/getrelationship"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Partially updates a relationship with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/patchrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/patchrelationship","metadata":{"seo":{"title":"Partially updates a relationship with the specified ID.","description":"This method will patch an existing relationship with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRelationship","name":"Partially updates a relationship with the specified ID.","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a relationship with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing relationship with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship to patch.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1relationships~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/relationships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationships/{tenantId}/{id}","href":"relationships/patchrelationship","openApiOperationId":"patchRelationship","summary":"Partially updates a relationship with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/patchrelationship"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Updates a relationship with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/updaterelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/updaterelationship","metadata":{"seo":{"title":"Updates a relationship with the specified ID.","description":"This method will update an existing relationship with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRelationship","name":"Updates a relationship with the specified ID.","isWebhook":false,"pointer":"/paths/~1relationships~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a relationship with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing relationship with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the relationship to update.","required":true}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","pointer":"/paths/~1relationships~1{tenantId}~1{id}/put/requestBody","description":"The updated relationship that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/relationships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Relationship"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/relationships/{tenantId}/{id}","href":"relationships/updaterelationship","openApiOperationId":"updateRelationship","summary":"Updates a relationship with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Relationship"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The relationship was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}},"schemaId":"components/schemas/Relationship","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The relationship supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The relationship could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The relationship could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve relationship based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1relationships~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Relationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Relationship"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/updaterelationship"}],"panels":[]}]},"httpPath":"/relationships/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Relationships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Relationships","showPageActions":true},{"nodeType":"markdoc","content":"Relationships"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/relationships/{tenantId}","summary":"Creates a new relationship record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relationships/createrelationship","deprecated":false},{"title":"/relationships/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/relationships/executebatchoperations","deprecated":false},{"title":"/relationships/{tenantId}/leftSide/{left_side_type}/{left_side_id}","summary":"Returns a list of records with the specified left_side_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/listrelationshipsbyleftsideid","deprecated":false},{"title":"/relationships/{tenantId}/rightSide/{right_side_type}/{right_side_id}","summary":"Returns a list of records with the specified right_side_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/listrelationshipsbyrightsideid","deprecated":false},{"title":"/relationships/{tenantId}/{id}","summary":"Returns a relationship from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/relationships/deleterelationship","deprecated":false},{"title":"/relationships/{tenantId}/{id}","summary":"Returns a relationship from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/getrelationship","deprecated":false},{"title":"/relationships/{tenantId}/{id}","summary":"Partially updates a relationship with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/relationships/patchrelationship","deprecated":false},{"title":"/relationships/{tenantId}/{id}","summary":"Updates a relationship with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/relationships/updaterelationship","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/rolodex/rolodex-v1/settings","routeSlug":"/apis/rolodex/rolodex-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/deletesetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/deletesetting","openApiOperationId":"deleteSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to delete setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/deletesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/getsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}","href":"settings/getsetting","openApiOperationId":"getSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1settings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/patchsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSetting","name":"Partially updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594","pointer":"/paths/~1settings~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_594"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/patchsetting","openApiOperationId":"patchSetting","summary":"Partially updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_594"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1settings~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/patchsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/createsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSetting","name":"Creates a new setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/post/requestBody","description":"The setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/createsetting","openApiOperationId":"createSetting","summary":"Creates a new setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to add setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1settings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/createsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/updatesetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSetting","name":"Updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/put/requestBody","description":"The updated setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/updatesetting","openApiOperationId":"updateSetting","summary":"Updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1settings~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/updatesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":"Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settings/deletesetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Partially updates a setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/patchsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Creates a new setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/createsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Updates a setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settings/updatesetting","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/apis/rolodex/rolodex-v1/statistics","routeSlug":"/apis/rolodex/rolodex-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/statistics/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statistics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statistics/{tenantId}/batch","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/batch","href":"statistics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/executebatchoperations"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/statistics/getstatistic","routeSlug":"/apis/rolodex/rolodex-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatistic","name":"Returns a statistic from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statistic from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statistic by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_591","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_591","description":"The ID of the statistic to return.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_591","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_591","description":"Indicates the API should force a consistent read on the data source."},{"name":"recalculate","in":"query","schemaId":"schema_620","description":"If true, the latest statistic will be calculated and the cache will be updated"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statistics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_591"},{"name":"id","in":"path","required":true,"schemaId":"schema_591"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_591"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_591"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_620"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/{id}","href":"statistics/getstatistic","openApiOperationId":"getStatistic","summary":"Returns a statistic from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","description":"Mock server","isMockServer":true},{"url":"https://rolodex.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statistic was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}},"schemaId":"components/schemas/Statistic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_593"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statistic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/getstatistic"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Statistics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statistics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statistics/executebatchoperations","deprecated":false},{"title":"/statistics/{tenantId}/{id}","summary":"Returns a statistic from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/getstatistic","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccountDelegationProcess":{"id":"components/schemas/AccountDelegationProcess","kind":"json-schema","title":"AccountDelegationProcess","data":{"additionalProperties":false,"properties":{"delegate_permission_request_email":{"additionalProperties":false,"description":"The email sent to the contact who needs to approve delegate access","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Delegate Permission Request Email","type":"object"},"delegate_request_granted_email":{"additionalProperties":false,"description":"The email sent once a contact approves delegate access","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Delegate Request Granted Email","type":"object"},"id":{"description":"The unique, string identifier of this account delegation process","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this account delegation process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the account delegation process","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["delegate_permission_request_email","delegate_request_granted_email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"additionalProperties":false,"description":"A complete address","properties":{"city":{"description":"The city of the address","title":"City","type":"string"},"country":{"description":"The country ISO code","title":"Country","type":"string"},"country_name":{"description":"The full name of hte country","title":"Country Name","type":"string"},"county":{"description":"The county","title":"County","type":"string"},"latitude":{"format":"double","title":"Latitude","type":"number"},"line1":{"description":"The first line of the address","title":"Line 1","type":"string"},"line2":{"description":"The second line of the address","title":"Line 2","type":"string"},"line3":{"description":"The third line of the address","title":"Line 3","type":"string"},"longitude":{"format":"double","title":"Longitude","type":"number"},"postal_code":{"description":"The zip/postal code","title":"Postal Code","type":"string"},"state":{"description":"The state/province of the address","title":"State","type":"string"},"time_zone_id":{"title":"Time Zone","type":"string"}},"type":"object"}},"components/schemas/AddressType":{"id":"components/schemas/AddressType","kind":"json-schema","title":"AddressType","data":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","contacts","organizations"],"title":"Applies To","type":"string"},"display_order":{"description":"The display order of the type","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this address type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this phone number type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the address type","title":"Name","type":"string"},"required_in_portal":{"description":"Whether or not this si required in the portal","title":"Required In Portal","type":"boolean"},"show_in_console":{"description":"Whether or not this should be displayed in the console","title":"Show In Console","type":"boolean"},"show_in_portal":{"description":"Whether or not this type should be displayed in the portal","title":"Show In Portal","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BatchOperationRequest":{"id":"components/schemas/BatchOperationRequest","kind":"json-schema","title":"BatchOperationRequest","data":{"additionalProperties":false,"properties":{"operations":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the record","oneOf":[{"x-required":true}],"title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"patch_directives":{"items":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"},"maxItems":100,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["id","object","operation","patch_directives"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchOperationResponse":{"id":"components/schemas/BatchOperationResponse","kind":"json-schema","title":"BatchOperationResponse","data":{"additionalProperties":false,"properties":{"error_count":{"description":"Number of error results","format":"float","title":"Error Count","type":"number"},"results":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"id":{"description":"The ID of the record","title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"outcome":{"enum":["error","no change","success"],"title":"Outcome","type":"string"}},"required":["id","operation"],"type":"object"},"type":"array"},"success_count":{"description":"Number of successful results","format":"float","title":"Success Count","type":"number"}},"type":"object"}},"components/schemas/CommunicationType":{"id":"components/schemas/CommunicationType","kind":"json-schema","title":"CommunicationType","data":{"additionalProperties":false,"properties":{"description":{"description":"A description of the type","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this communication type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this communication type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the communication type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Contact":{"id":"components/schemas/Contact","kind":"json-schema","title":"Contact","data":{"additionalProperties":false,"properties":{"communication_preferences":{"description":"The communication types to which this person is subscribed","items":{"additionalProperties":false,"properties":{"communication_type_id":{"title":"Communication Type","type":"string"},"enabled":{"title":"Enabled","type":"boolean"},"subscription_email_address":{"description":"The email address associated with this subscription, if different from the primary email address for this contact","title":"Subscription Email Address","type":"string"},"subscription_last_updated":{"description":"The date that this subscription was last changed","format":"date-time","title":"Subscription Last Updated","type":"string"},"subscription_status":{"description":"The subscription status requested by this contact","enum":["digest","subscribed","unsubscribed"],"title":"Subscription Status","type":"string"}},"required":["communication_type_id","enabled"],"type":"object"},"type":"array"},"communication_preferences_last_confirmed":{"description":"The date that the communication preferences were last confirmed for this contact","format":"date-time","title":"Communication Preferences Last Confirmed","type":"string"},"contact_role_ids":{"description":"The ids of the contact roles this contact plays in the linked organization.","items":{"type":"string"},"title":"Contact Roles","type":"array"},"contact_roles":{"description":"READ ONLY - the name of contact roles","title":"Contact Roles","type":"string"},"credentials":{"description":"Professional credentials/designation (MBA, Esq, PhD, etc)","title":"Credentials","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date_of_birth":{"description":"The date of birth of the contact, expressed in ISO-8601 date format","format":"date","title":"Date Of Birth","type":"string"},"date_of_death":{"description":"The date this contact passed away","format":"date-time","title":"Date Of Death","type":"string"},"date_profile_last_updated":{"description":"The date that this contact profile was last updated","format":"date-time","title":"Date Profile Last Updated","type":"string"},"date_social_profile_last_updated":{"description":"The date that the social profile was last updated","format":"date","title":"Social Profile Last Updated","type":"string"},"do_not_call":{"description":"If so, the person is not to be called","title":"Do Not Call","type":"boolean"},"do_not_mail":{"description":"If set, no mail goes to the contact","title":"Do Not Mail","type":"boolean"},"email_address":{"description":"The primary email address","title":"Email Address","type":"string"},"email_address2":{"description":"Secondary email address","title":"Email Address2","type":"string"},"email_address3":{"description":"Tertiary email address","title":"Email Address3","type":"string"},"email_opt_out":{"description":"This contact has opted out of ALL email communications","title":"Email Opt Out","type":"boolean"},"facebook":{"description":"Url to the contact's Facebook account","title":"Facebook","type":"string"},"fax_phone_number":{"description":"Fax phone number","title":"Fax Phone Number","type":"string"},"first_name":{"description":"The first name","title":"First Name","type":"string"},"full_name":{"description":"Full name","title":"Full Name","type":"string"},"gender":{"description":"The gender of the contact","enum":["female","male"],"title":"Gender","type":"string"},"home_address":{"$ref":"#/components/schemas/Address"},"home_phone_number":{"description":"Home phone number","title":"Home Phone Number","type":"string"},"id":{"description":"The unique, string identifier of this contact","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"image_url":{"description":"A url of the image/photo of this contact","title":"Image Url","type":"string"},"instagram":{"description":"Url to the contact's Instagram account","title":"Instagram","type":"string"},"job_title":{"description":"The contact's professional title","title":"Job Title","type":"string"},"last_name":{"description":"The last name","title":"Last Name","type":"string"},"link_work_address_to_organization":{"description":"When set, a change in the organization's address changes the contact work address","title":"Link Work Address To Organization","type":"boolean"},"link_work_phone_number_to_organization":{"description":"When set, a change in the organization's phone changes the contact work phone","title":"Link Work Phone Number To Organization","type":"boolean"},"linked_in":{"description":"Url to the contact's LinkedIn account","title":"LinkedIn","type":"string"},"maiden_name":{"description":"The maiden name","title":"Maiden Name","type":"string"},"merged_ids":{"description":"A list contact IDs that have been merged into this contact","items":{"type":"string"},"title":"Mergeds","type":"array"},"middle_name":{"description":"The middle name/initial","title":"Middle Name","type":"string"},"mobile_phone_number":{"description":"Mobile phone number","title":"Mobile Phone Number","type":"string"},"name":{"description":"The full name of the contact","title":"Name","type":"string"},"name_last_first":{"description":"The full name of the contact, last first","title":"Name Last First","type":"string"},"national_district":{"description":"The name of the United States congressional district","title":"National District","type":"string"},"national_district_ocdId":{"description":"The Open Civic Data division identifier of the United States congressional district","title":"National District OCD-ID","type":"string"},"new_organization_info":{"additionalProperties":false,"properties":{},"title":"New Organization Info","type":"object"},"nickname":{"description":"The nickname of the contact","title":"Nickname","type":"string"},"notes":{"description":"Any contact notes","title":"Notes","type":"string"},"number":{"description":"The contact number","format":"float","title":"Number","type":"number"},"organization_history":{"description":"A list of previous organization affiliations","items":{"additionalProperties":false,"properties":{"contact_role_ids":{"description":"The ids of the contact roles this contact plays in the linked organization.","items":{"type":"string"},"title":"Contact Roles","type":"array"},"end_date":{"description":"The end date of the contacts time at the organization","format":"date","title":"End Date","type":"string"},"job_title":{"description":"The title that was held at the organization","title":"Job Title","type":"string"},"notes":{"description":"Any relevant notes","title":"Notes","type":"string"},"organization_id":{"description":"The ID of the organization","title":"Organization","type":"string"},"start_date":{"description":"The start date of the contacts time at the organization","format":"date","title":"Start Date","type":"string"}},"required":["organization_id"],"type":"object"},"type":"array"},"organization_id":{"description":"The ID of the organization that the contact belongs to","title":"Organization","type":"string"},"organization_name":{"description":"The name of the organization; if an organization ID is present, this information is automatically populated","title":"Organization Name","type":"string"},"origin_service":{"description":"If this contact was created by another service, the service is here","title":"Origin Service","type":"string"},"origin_service_record_id":{"description":"If this  contact was created by another service, the relevant iD","title":"Origin Service Record","type":"string"},"other_addresses":{"items":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"type_id":{"description":"The address type","title":"Type","type":"string"}},"required":["address","type_id"],"type":"object"},"type":"array"},"other_phone_numbers":{"items":{"additionalProperties":false,"properties":{"phone_number":{"description":"The phone number","title":"Phone Number","type":"string"},"type_id":{"description":"The phone number type","title":"Type","type":"string"}},"required":["phone_number","type_id"],"type":"object"},"type":"array"},"override_automatic_region_assignment":{"description":"If true, the region assignment for this record is overridden and should not be automatically assigned","title":"Override Automatic Region Assignment","type":"boolean"},"portal_delegates":{"description":"Allows for this contact to be managed by other contacts in the portal","items":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact","title":"Contact","type":"string"},"expiration_date":{"description":"The date until which this delegation is active","format":"date-time","title":"Expiration Date","type":"string"},"status":{"enum":["approved"],"title":"Status","type":"string"}},"required":["contact_id"],"type":"object"},"minItems":1,"type":"array"},"preferred_address":{"$ref":"#/components/schemas/Address"},"preferred_address_type":{"description":"The address at which the contact prefers to be contacted","enum":["alternate","home","school","work"],"title":"Preferred Address Type","type":"string"},"preferred_address_type_id":{"description":"When a alternate phone number type is preferred, the ID","title":"Preferred Alternate Address Type","type":"string"},"preferred_phone_number":{"description":"The preferred phone number, calculated based on the preferred phone number type","title":"Preferred Phone Number","type":"string"},"preferred_phone_number_type":{"description":"The phone number at which the contact prefers to be reach","enum":["alternate","fax","home","mobile","school","work","work mobile"],"title":"Preferred Phone Number Type","type":"string"},"preferred_phone_number_type_id":{"description":"When a alternate phone number type is preferred, the ID","title":"Preferred Alternate Phone Number Type","type":"string"},"prefix":{"description":"The contact prefix","title":"Prefix","type":"string"},"pronouns":{"title":"Pronouns","type":"string"},"region_id":{"description":"The region","title":"Region","type":"string"},"salutation":{"description":"The contact salutation","title":"Salutation","type":"string"},"school_address":{"$ref":"#/components/schemas/Address"},"school_phone_number":{"description":"Fax phone number","title":"School Phone Number","type":"string"},"seasonal_address":{"$ref":"#/components/schemas/Address"},"seasonal_address_end":{"description":"The end  date for the seasonal address","format":"date-time","title":"Seasonal Address End","type":"string"},"seasonal_address_start":{"description":"The start date for the seasonal address","format":"date-time","title":"Seasonal Address Start","type":"string"},"spouse_id":{"description":"The ID of this person's spouse","title":"Spouse","type":"string"},"state_lower_district":{"description":"The name of the US state lower (House) district","title":"State Lower District","type":"string"},"state_lower_district_ocdId":{"description":"The Open Civic Data division identifier of the US state lower (House) district","title":"State Lower District OCD-ID","type":"string"},"state_upper_district":{"description":"The name of the US state upper (Senate) district","title":"State Upper District","type":"string"},"state_upper_district_ocdId":{"description":"The Open Civic Data division identifier of the US state upper (Senate) district","title":"State Upper District OCD-ID","type":"string"},"status":{"description":"The status of the contact record","enum":["active","deceased","duplicate","inactive"],"title":"Status","type":"string"},"suffix":{"description":"The contact suffix (Jr., Sr., etc0","title":"Suffix","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"twitter":{"description":"Url to the contact's Twitter account","title":"Twitter","type":"string"},"user_ids":{"description":"A list of related portal user IDs","items":{"type":"string"},"title":"Users","type":"array"},"work_address":{"$ref":"#/components/schemas/Address"},"work_mobile_phone_number":{"description":"Mobile phone number for business unit","title":"Work Mobile Phone Number","type":"string"},"work_phone_number":{"description":"Work phone number","title":"Work Phone Number","type":"string"}},"required":["id","preferred_address_type_id","preferred_phone_number_type_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactDirectory":{"id":"components/schemas/ContactDirectory","kind":"json-schema","title":"ContactDirectory","data":{"additionalProperties":false,"properties":{"additional_fields":{"description":"These are additional fields that should be in the directory query, which will be available in the search results","items":{"type":"string"},"title":"Additional Fields","type":"array"},"comment_options":{"additionalProperties":false,"properties":{"comments_header_text":{"description":"The text shown in the header of the comments section","title":"Comments Header Text","type":"string"},"comments_instructions":{"description":"Instructions given to those submitting comments","title":"Comments Instructions","type":"string"},"comments_placeholder_text":{"description":"The placeholder text for the comments","title":"Comments Placeholder Text","type":"string"},"enable_ratings":{"description":"If set, users can rate","title":"Enable Ratings","type":"boolean"},"hide_submitter_name":{"description":"If set, comment submitter names are hidden from the directory","title":"Hide Submitter Name","type":"boolean"},"leave_comment_button_text":{"description":"The button text for Leave Comment","title":"Leave Comment Button Text","type":"string"},"max_rating":{"description":"The maximum rating","format":"float","maximum":10,"minimum":1,"oneOf":[{"x-required":true}],"title":"Max Rating","type":"number"},"no_comments_text":{"description":"The text shown when no comments are present","title":"No Comments Text","type":"string"},"rating_label":{"description":"The label for the rating","title":"Rating Label","type":"string"},"save_comment_button":{"description":"The button text for saving a comment","title":"Save Comment Button","type":"string"}},"title":"Comment Options","type":"object"},"custom_directory_entry_template":{"title":"Custom Directory Entry Template","type":"string"},"custom_search_results_template":{"title":"Custom Search Results Template","type":"string"},"custom_sort_fields":{"items":{"additionalProperties":false,"properties":{"descending":{"title":"Descending","type":"boolean"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"directory_entry_mode":{"enum":["custom","do not show","use default"],"title":"Directory Entry Mode","type":"string"},"display_mode":{"description":"The way that the directory should be displayed","enum":["list","search"],"title":"Display Mode","type":"string"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Criteria","type":"object"},"enable_comments":{"description":"If set, users are allowed to submit comments in the directory","title":"Enable Comments","type":"boolean"},"enable_custom_search_results_template":{"description":"If set, a custom search results template is displayed","title":"Enable Custom Search Results Template","type":"boolean"},"enable_custom_sorting":{"description":"If true, the directory results will be sorted differently that the query","title":"Enable Custom Sorting","type":"boolean"},"enable_eligibility_criteria":{"description":"If set, only certain people can access this directory","title":"Enable Eligibility Criteria","type":"boolean"},"enable_messaging":{"description":"When true, users are able to contact other users through the directory","title":"Enable Messaging","type":"boolean"},"enable_query_expression_filter":{"description":"If set to true, an expression can be used to further filter the query","title":"Enable Query Expression Filter","type":"boolean"},"enable_query_filter":{"description":"If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used","title":"Enable Query Filter","type":"boolean"},"enable_radius_search":{"description":"If true, the user can search across zip code radius","title":"Enable Radius Search","type":"boolean"},"id":{"description":"The unique, string identifier of this contact directory","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this directory is active","title":"Is Active","type":"boolean"},"is_public":{"description":"If true, this is a public directory that can be accessed without security","title":"Is Public","type":"boolean"},"name":{"description":"The name of the contact directory","title":"Name","type":"string"},"page_size":{"description":"The page size, used for server side page and to combat scraping attacks","format":"float","maximum":50,"minimum":1,"title":"Page Size","type":"number"},"query_filter_expression":{"description":"The expression to use to filter the directory","title":"Query Filter Expression","type":"string"},"query_filter_rules":{"title":"Query Filter Rules","type":"object"},"radius_search_options":{"additionalProperties":false,"properties":{"postal_code_field":{"description":"The field to use as the basis for a radius search","title":"Postal Code Field","type":"string"},"radius_options":{"description":"The various default radius that can be selected","items":{"format":"float","type":"number"},"minItems":1,"title":"Radius Options","type":"array"}},"required":["postal_code_field","radius_options"],"title":"Radius Search Options","type":"object"},"refresh_period":{"description":"The period of time (in minutes) after which the directory should refresh it self","format":"float","minimum":5,"title":"Refresh Period","type":"number"},"searchable_fields":{"description":"The fields in the directory that are displayed as search criteria","items":{"additionalProperties":false,"properties":{"group_name":{"description":"The group/display label","title":"Group Name","type":"string"},"label":{"description":"The label that the field should be displayed","title":"Label","type":"string"},"name":{"description":"The field name","title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["custom_directory_entry_template","custom_search_results_template","custom_sort_fields","eligibility_criteria","id","name","query_filter_expression","radius_search_options","searchable_fields","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactDistrict":{"id":"components/schemas/ContactDistrict","kind":"json-schema","title":"ContactDistrict","data":{"properties":{"id":{"description":"The unique, string identifier of this contact","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"us_national":{"description":"The name of the United States congressional district","title":"Us National","type":"string"},"us_state_lower":{"description":"The name of the state lower (House) district","title":"Us State Lower","type":"string"},"us_state_upper":{"description":"The name of the state upper (Senate) district","title":"Us State Upper","type":"string"}},"required":["id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactDuplicate":{"id":"components/schemas/ContactDuplicate","kind":"json-schema","title":"ContactDuplicate","data":{"additionalProperties":false,"properties":{"alt_address_postal_code":{"description":"An alternative address postal code of the contact","title":"Alt Address Postal Code","type":"string"},"email_address":{"description":"The primary email address","title":"Email Address","type":"string"},"email_address2":{"description":"Secondary email address","title":"Email Address2","type":"string"},"email_address3":{"description":"Tertiary email address","title":"Email Address3","type":"string"},"first_name":{"description":"The contact's first name","title":"First Name","type":"string"},"first_name_metaphones":{"description":"The metaphones calculated from the contact's first name","items":{"type":"string"},"title":"First Name Metaphones","type":"array"},"first_name_primary_metaphone":{"description":"The primary metaphone calculated from the contact's first name","title":"First Name Primary Metaphone","type":"string"},"first_name_secondary_metaphone":{"description":"The secondary metaphone calculated from the contact's first name","title":"First Name Secondary Metaphone","type":"string"},"highest_confidence":{"description":"The highest confidence score within the possible duplicates excluding whitelisted records","format":"float","title":"Highest Confidence","type":"number"},"home_address_postal_code":{"description":"The home address postal code of the contact","title":"Home Address Postal Code","type":"string"},"home_phone_number":{"description":"Home phone number","title":"Home Phone Number","type":"string"},"id":{"description":"The unique, string identifier of this contact","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"last_name":{"description":"The contact's last name","title":"Last Name","type":"string"},"last_name_metaphones":{"description":"The metaphones calculated from the contact's last name","items":{"type":"string"},"title":"Last Name Metaphones","type":"array"},"last_name_primary_metaphone":{"description":"The primary metaphone calculated from the contact's last name","title":"Last Name Primary Metaphone","type":"string"},"last_name_secondary_metaphone":{"description":"The secondary metaphone calculated from the contact's last name","title":"Last Name Secondary Metaphone","type":"string"},"manual_duplicates":{"description":"The IDs of contacts that have been manually identified as duplicates of this contact","items":{"type":"string"},"title":"Manual Duplicates","type":"array"},"middle_name":{"description":"The contact's middle name","title":"Middle Name","type":"string"},"mobile_phone_number":{"description":"Mobile phone number","title":"Mobile Phone Number","type":"string"},"number_of_possible_duplicates":{"description":"The number of possible duplicates excluding whitelisted records","format":"float","title":"Number Of Possible Duplicates","type":"number"},"organization_id":{"description":"The ID of the organization that the contact belongs to","title":"Organization","type":"string"},"other_phone_numbers":{"items":{"additionalProperties":false,"properties":{"phone_number":{"description":"The phone number","title":"Phone Number","type":"string"},"type_id":{"description":"The phone number type","title":"Type","type":"string"}},"required":["phone_number","type_id"],"type":"object"},"type":"array"},"phone_numbers":{"description":"All of the contact's phone numbers","items":{"type":"string"},"title":"Phone Numbers","type":"array"},"possible_duplicates":{"description":"The contacts that are potentially duplicates of this contact","items":{"additionalProperties":false,"properties":{"confidence":{"description":"The likelihood that these two contacts are duplicates on a scale of 1 to 100","format":"float","title":"Confidence","type":"number"},"match":{"description":"The ID of a contact that is potentially a duplicate of this contact","title":"Match","type":"string"}},"required":["confidence","match"],"type":"object"},"type":"array"},"postal_codes":{"description":"The postal codes off all the contact's addresses","items":{"type":"string"},"title":"Postal Codes","type":"array"},"preferred_address":{"$ref":"#/components/schemas/Address"},"school_phone_number":{"description":"Fax phone number","title":"School Phone Number","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_match_directive":{"title":"Sys Match Directive","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"whitelist":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of contacts that have been manually identified as not duplicates of this contact. These IDs may appear in the possible_duplicates array but should not be presented"},"children":[]}]}]}],"items":{"type":"string"},"title":"Whitelist","type":"array"},"work_address_postal_code":{"description":"The work address postal code of the contact","title":"Work Address Postal Code","type":"string"},"work_mobile_phone_number":{"description":"Mobile phone number for business unit","title":"Work Mobile Phone Number","type":"string"},"work_phone_number":{"description":"Work phone number","title":"Work Phone Number","type":"string"}},"required":["id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactDuplicateCheck":{"id":"components/schemas/ContactDuplicateCheck","kind":"json-schema","title":"ContactDuplicateCheck","data":{"additionalProperties":false,"properties":{"alt_address_postal_code":{"description":"An alternative address postal code of the contact","title":"Alt Address Postal Code","type":"string"},"email_address":{"description":"The primary email address","title":"Email Address","type":"string"},"email_address2":{"description":"Secondary email address","title":"Email Address2","type":"string"},"email_address3":{"description":"Tertiary email address","title":"Email Address3","type":"string"},"first_name":{"description":"The contact's first name","title":"First Name","type":"string"},"home_address_postal_code":{"description":"The home address postal code of the contact","title":"Home Address Postal Code","type":"string"},"last_name":{"description":"The contact's last name","title":"Last Name","type":"string"},"minimum_confidence":{"description":"The minimum degree of confidence on a scale of 1 to 100 that you would like considered a potential duplicate","format":"float","title":"Minimum Confidence","type":"number"},"work_address_postal_code":{"description":"The work address postal code of the contact","title":"Work Address Postal Code","type":"string"}},"type":"object"}},"components/schemas/ContactLoginProfile":{"id":"components/schemas/ContactLoginProfile","kind":"json-schema","title":"ContactLoginProfile","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this contact login profile","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"last_ip":{"description":"The last IP address the user logged in with","title":"Last Ip","type":"string"},"last_portal_login_date":{"description":"The last time the user logged into the portal","format":"date-time","title":"Last Portal Login Date","type":"string"},"login_count":{"description":"The number of logins","format":"float","title":"Login Count","type":"number"},"notes":{"title":"Notes","type":"string"},"portal_user_name":{"description":"The Auth0 user name for this contact","title":"Portal User Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactRole":{"id":"components/schemas/ContactRole","kind":"json-schema","title":"ContactRole","data":{"additionalProperties":false,"properties":{"administrative_contact":{"description":"Whether or not people with this role should be considered administrative contacts, and receive important information","title":"Administrative Contact","type":"boolean"},"assign_automatically":{"description":"Assign this role automatically to new contacts","title":"Assign Automatically","type":"boolean"},"assign_automatically_to_first_contact":{"description":"Assign this role automatically the first contact for the organization","title":"Assign Automatically To First Contact","type":"boolean"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Description of the role","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this contact role","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the contact role is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the contact role","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","is_active","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactRoleRuleSet":{"id":"components/schemas/ContactRoleRuleSet","kind":"json-schema","title":"ContactRoleRuleSet","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this contact role rule set","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this contact role rule set is active","title":"Is Active","type":"boolean"},"matching_conditions":{"additionalProperties":false,"description":"The conditions for which this rule applies","properties":{"all":{"items":{"additionalProperties":false,"properties":{"all":{"title":"All","type":"object"},"any":{"title":"Any","type":"object"},"fact":{"description":"The piece of data being examined","title":"Fact","type":"string"},"operator":{"description":"The operator","enum":["contains","containsString","doesNotContain","equal","greaterThan","greaterThanInclusive","in","isBlank","isNotBlank","lessThan","lessThanInclusive","matchesPatter","notContainsString","notEqual","notIn","regex"],"title":"Operator","type":"string"},"path":{"description":"The path of the value being tested","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"},"any":{"items":{"additionalProperties":false,"properties":{"all":{"title":"All","type":"object"},"any":{"title":"Any","type":"object"},"fact":{"description":"The piece of data being examined","title":"Fact","type":"string"},"operator":{"description":"The operator","enum":["contains","containsString","doesNotContain","equal","greaterThan","greaterThanInclusive","in","isBlank","isNotBlank","lessThan","lessThanInclusive","matchesPatter","notContainsString","notEqual","notIn","regex"],"title":"Operator","type":"string"},"path":{"description":"The path of the value being tested","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"}},"title":"Matching Conditions","type":"object"},"name":{"description":"The name of the contact role rule set","title":"Name","type":"string"},"requirements":{"items":{"additionalProperties":false,"properties":{"contact_role_id":{"description":"The applicable contact role","title":"Contact Role","type":"string"},"maximum":{"description":"The maximum number of contacts an organization can have with this role","format":"float","title":"Maximum","type":"number"},"minimum":{"description":"The minimum number of contacts an organization can have with this role","format":"float","title":"Minimum","type":"number"}},"required":["contact_role_id"],"type":"object"},"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ContactSearchParameters":{"id":"components/schemas/ContactSearchParameters","kind":"json-schema","title":"ContactSearchParameters","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"contact_role_id":{"title":"Contact Role","type":"string"},"country":{"description":"The country","title":"Country","type":"string"},"email_address":{"title":"Email Address","type":"string"},"first_name":{"title":"First Name","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"job_title":{"title":"Job Title","type":"string"},"last_name":{"title":"Last Name","type":"string"},"nickname":{"title":"Nickname","type":"string"},"number":{"items":{"format":"float","type":"number"},"title":"Number","type":"array"},"organization_id":{"items":{"type":"string"},"title":"Organization","type":"array"},"organization_name":{"title":"Organization Name","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"}},"type":"object"}},"components/schemas/ContactSearchResults":{"id":"components/schemas/ContactSearchResults","kind":"json-schema","title":"ContactSearchResults","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"email_address":{"title":"Email Address","type":"string"},"first_name":{"title":"First Name","type":"string"},"id":{"title":"ID","type":"string"},"job_title":{"title":"Job Title","type":"string"},"last_name":{"title":"Last Name","type":"string"},"nickname":{"title":"Nickname","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"organization_id":{"title":"Organization","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/CustomActivity":{"id":"components/schemas/CustomActivity","kind":"json-schema","title":"CustomActivity","data":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact that performed the activity","title":"Contact","type":"string"},"custom_activity_type_id":{"description":"The custom activity type","title":"Custom Activity Type","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The activity date","format":"date-time","title":"Date","type":"string"},"description":{"description":"Activity description","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this activity","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"organization_id":{"description":"The organization to which the activity is linked","title":"Organization","type":"string"},"owner_type":{"description":"The type of owner","title":"Owner Type","type":"string"},"summary":{"description":"A summary of the activity","title":"Summary","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["contact_id","custom_activity_type_id","date","id","organization_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CustomActivityType":{"id":"components/schemas/CustomActivityType","kind":"json-schema","title":"CustomActivityType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"icon_class":{"description":"The icon class displayed in the activity timeline","title":"Icon Class","type":"string"},"icon_color":{"description":"The icon color displayed in the activity timeline","title":"Icon Color","type":"string"},"id":{"description":"The unique, string identifier of this custom activity type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the custom activity type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","is_active","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CustomEngagementMetric":{"id":"components/schemas/CustomEngagementMetric","kind":"json-schema","title":"CustomEngagementMetric","data":{"additionalProperties":false,"properties":{"expression":{"title":"Expression","type":"string"},"id":{"description":"The unique, string identifier of this custom engagement metric","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this custom engagement metric is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the custom engagement metric","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["contact fields","membership fields","rockset view"],"title":"Type","type":"string"},"view":{"title":"View","type":"string"}},"required":["expression","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type","view"],"type":"object"}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"additionalProperties":false,"properties":{"boolean_value":{"description":"The boolean value","title":"Boolean Value","type":"boolean"},"custom_field_id":{"description":"The unique identifier of the custom field","title":"Custom Field","type":"string"},"file_url_value":{"description":"The pointer to a file value","title":"File Url Value","type":"string"},"list_value":{"description":"The list value","items":{"type":"string"},"title":"List Value","type":"array"},"numeric_value":{"description":"The numeric value","format":"float","title":"Numeric Value","type":"number"},"string_value":{"description":"The string value of the custom field","title":"String Value","type":"string"},"table_value":{"description":"A list of objects (a table)","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/DirectoryMessage":{"id":"components/schemas/DirectoryMessage","kind":"json-schema","title":"DirectoryMessage","data":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"type":"object"}},"components/schemas/DirectorySearchCriteria":{"id":"components/schemas/DirectorySearchCriteria","kind":"json-schema","title":"DirectorySearchCriteria","data":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"page":{"description":"The page being requested","format":"float","title":"Page","type":"number"},"radius_search":{"additionalProperties":false,"properties":{"postal_code":{"title":"Postal Code","type":"string"},"radius":{"format":"float","minimum":1,"title":"Radius","type":"number"}},"required":["postal_code","radius"],"title":"Radius Search","type":"object"}},"type":"object"}},"components/schemas/DirectorySearchResults":{"id":"components/schemas/DirectorySearchResults","kind":"json-schema","title":"DirectorySearchResults","data":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"},"type":"array"},"query":{"additionalProperties":false,"properties":{},"title":"Query","type":"object"},"rows":{"items":{"type":"object"},"type":"array"},"sql":{"title":"Sql","type":"string"},"target_service":{"description":"The target service of the query","title":"Target Service","type":"string"},"totalNumberOfRows":{"format":"float","title":"Totalnumberofrows","type":"number"}},"type":"object"}},"components/schemas/EngagementCategory":{"id":"components/schemas/EngagementCategory","kind":"json-schema","title":"EngagementCategory","data":{"additionalProperties":false,"properties":{"color":{"description":"The color of the engagement","title":"Color","type":"string"},"id":{"description":"The unique, string identifier of this engagement category","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this engagement category is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the engagement category","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/EngagementModel":{"id":"components/schemas/EngagementModel","kind":"json-schema","title":"EngagementModel","data":{"additionalProperties":false,"properties":{"components":{"items":{"additionalProperties":false,"properties":{"custom_metric_id":{"description":"The custom to use for engagement","oneOf":[{"x-required":true}],"title":"Custom Metric","type":"string"},"metric_rules":{"items":{"additionalProperties":false,"properties":{"ending_range":{"description":"The ending range for the rule","format":"float","title":"Ending Range","type":"number"},"points":{"description":"Points to assign, 100 total max","format":"float","maximum":100,"minimum":0,"title":"Points","type":"number"},"starting_range":{"description":"The starting range for the rule","format":"float","title":"Starting Range","type":"number"}},"required":["points","starting_range"],"type":"object"},"minItems":1,"type":"array"},"metric_type":{"enum":["custom","system"],"title":"Metric Type","type":"string"},"name":{"description":"Name of the component","title":"Name","type":"string"},"system_metric":{"description":"The metric to use for engagement","oneOf":[{"x-required":true}],"title":"System Metric","type":"string"},"weight":{"description":"The weight out of 100","format":"float","maximum":100,"minimum":1,"title":"Weight","type":"number"}},"required":["metric_rules","metric_type","name","weight"],"type":"object"},"type":"array"},"enable_engagement_categories":{"description":"If true, contacts are assigned categories based on engagement scores","title":"Enable Engagement Categories","type":"boolean"},"engagement_category_rules":{"items":{"additionalProperties":false,"properties":{"category_id":{"description":"The engagement category","title":"Category","type":"string"},"maximum_percentile_rank":{"description":"Maximum percentile rank to match this rule","format":"float","title":"Maximum Percentile Rank","type":"number"},"maximum_score":{"description":"Maximum score to match this rule","format":"float","title":"Maximum Score","type":"number"},"minimum_percentile_rank":{"description":"Minimum percentile rank to match this rule","format":"float","title":"Minimum Percentile Rank","type":"number"},"minimum_score":{"description":"Minimum score to match this rule","format":"float","title":"Minimum Score","type":"number"}},"required":["category_id","maximum_score","minimum_score"],"type":"object"},"minItems":1,"type":"array"},"id":{"description":"The unique, string identifier of this engagement model","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the model is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the engagement model","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The target of this engagement model","enum":["contact","organization"],"title":"Type","type":"string"}},"required":["engagement_category_rules","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/EngagementScore":{"id":"components/schemas/EngagementScore","kind":"json-schema","title":"EngagementScore","data":{"additionalProperties":false,"properties":{"category_id":{"description":"Engagement category","title":"Category","type":"string"},"components":{"items":{"additionalProperties":false,"properties":{"name":{"description":"Name of the scoring component, from the model","title":"Name","type":"string"},"percentile_rank":{"description":"The percentile rank of this score compared to others","format":"float","title":"Percentile Rank","type":"number"},"raw_score":{"description":"Raw score out of 100","format":"float","title":"Raw Score","type":"number"},"weight":{"description":"How the score is weighted","format":"float","title":"Weight","type":"number"},"weighted_score":{"description":"Score when weighted","format":"float","title":"Weighted Score","type":"number"}},"required":["name","percentile_rank","raw_score","weight","weighted_score"],"type":"object"},"minItems":1,"type":"array"},"contact_id":{"description":"The contact","title":"Contact","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"date":{"description":"The date of the score","title":"Date","type":"string"},"date_of_first_engagement":{"description":"The date of the first engagement","title":"Date Of First Engagement","type":"string"},"engagement_model_id":{"description":"The engagement model used to calculate this score","title":"Engagement Model","type":"string"},"id":{"description":"The unique, string identifier of this engagement score","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"md5_hash":{"description":"A hash that prevents bulk routines from unnecessarily writing unchanged data","title":"Md5 Hash","type":"string"},"notes":{"title":"Notes","type":"string"},"number_of_months_since_first_engagement":{"description":"Number of months since first engagement","format":"float","title":"Number Of Months Since First Engagement","type":"number"},"organization_id":{"description":"The organization","title":"Organization","type":"string"},"percentile_rank":{"description":"Where this person ranks","format":"float","title":"Percentile Rank","type":"number"},"previous_year_percentile_rank":{"description":"The percentile rank for the previous year","format":"float","title":"Previous Year Percentile Rank","type":"number"},"previous_year_percentile_rank_change":{"description":"The change in percentile rank for the previous year","format":"float","title":"Previous Year Percentile Rank Change","type":"number"},"previous_year_score":{"description":"Score for the previous year","format":"float","title":"Previous Year Score","type":"number"},"previous_year_score_percentage_change":{"description":"Amount of change in absolute value from previous year score","format":"float","title":"Previous Year Score Percentage Change","type":"number"},"previous_year_score_value_change":{"description":"Amount of change in absolute value from previous year score","format":"float","title":"Previous Year Score Value Change","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_score":{"description":"The score","format":"float","title":"Total Score","type":"number"}},"required":["components","contact_id","customer_type","date","id","organization_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total_score"],"type":"object"}},"components/schemas/FieldConflictReport":{"id":"components/schemas/FieldConflictReport","kind":"json-schema","title":"FieldConflictReport","data":{"properties":{"conflicting_fields":{"items":{"type":"string"},"type":"array"},"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"organizations":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array"}},"type":"object"}},"components/schemas/GetCustomerRawMetricDataResponse":{"id":"components/schemas/GetCustomerRawMetricDataResponse","kind":"json-schema","title":"GetCustomerRawMetricDataResponse","data":{"additionalProperties":false,"properties":{"date":{"description":"The date","title":"Date","type":"string"},"metric_data":{"items":{"additionalProperties":false,"properties":{"group_id":{"title":"Group","type":"string"},"group_name":{"title":"Group Name","type":"string"},"metrics":{"items":{"additionalProperties":false,"properties":{"id":{"title":"ID","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"},"raw_data":{"additionalProperties":false,"properties":{},"title":"Raw Data","type":"object"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/GetMetricsResponse":{"id":"components/schemas/GetMetricsResponse","kind":"json-schema","title":"GetMetricsResponse","data":{"items":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","contacts","organizations"],"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"module_id":{"type":"string"},"module_name":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"components/schemas/ListContactsResponse":{"id":"components/schemas/ListContactsResponse","kind":"json-schema","title":"ListContactsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCustomActivitiesResponse":{"id":"components/schemas/ListCustomActivitiesResponse","kind":"json-schema","title":"ListCustomActivitiesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CustomActivity"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListEngagementScoresResponse":{"id":"components/schemas/ListEngagementScoresResponse","kind":"json-schema","title":"ListEngagementScoresResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/EngagementScore"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListOrganizationsResponse":{"id":"components/schemas/ListOrganizationsResponse","kind":"json-schema","title":"ListOrganizationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRelationshipsResponse":{"id":"components/schemas/ListRelationshipsResponse","kind":"json-schema","title":"ListRelationshipsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Relationship"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStandardQueryDefinitionsResponse":{"id":"components/schemas/ListStandardQueryDefinitionsResponse","kind":"json-schema","title":"ListStandardQueryDefinitionsResponse","data":{"items":{"$ref":"#/components/schemas/StandardQueryDefinition"},"type":"array"}},"components/schemas/MergeContact":{"id":"components/schemas/MergeContact","kind":"json-schema","title":"MergeContact","data":{"additionalProperties":false,"properties":{"options":{"additionalProperties":false,"properties":{"fields":{"description":"Change the way certain merge field behave","items":{"additionalProperties":false,"properties":{"field_name":{"description":"The field name ","title":"Field Name","type":"string"},"use_source_id":{"title":"Use Source","type":"string"}},"required":["field_name"],"type":"object"},"type":"array"}},"title":"Options","type":"object"},"source_ids":{"description":"The source IDs to merge","items":{"type":"string"},"minItems":1,"title":"Sources","type":"array"}},"required":["source_ids"],"type":"object"}},"components/schemas/MergeContactRequest":{"id":"components/schemas/MergeContactRequest","kind":"json-schema","title":"MergeContactRequest","data":{"additionalProperties":false,"properties":{"ids":{"items":{"type":"string"},"title":"Ids","type":"array"},"resolved_conflicts":{"items":{"additionalProperties":false,"properties":{"field":{"title":"Field","type":"string"},"id":{"description":"The object to use for the fields","title":"ID","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/MergeRequest":{"id":"components/schemas/MergeRequest","kind":"json-schema","title":"MergeRequest","data":{"additionalProperties":false,"properties":{"options":{"additionalProperties":false,"properties":{"fields":{"description":"Change the way certain merge field behave","items":{"additionalProperties":false,"properties":{"field_name":{"description":"The field name ","title":"Field Name","type":"string"},"use_source_id":{"title":"Use Source","type":"string"}},"required":["field_name"],"type":"object"},"type":"array"}},"title":"Options","type":"object"},"source_ids":{"description":"The source IDs to merge","items":{"type":"string"},"minItems":1,"title":"Sources","type":"array"}},"required":["source_ids"],"type":"object"}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"additionalProperties":false,"properties":{"acronym":{"description":"The acronym for the organization, if applicable","title":"Acronym","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"alt_phone_number":{"description":"The alternative phone number","title":"Alt Phone Number","type":"string"},"alternate_domain_names":{"description":"Alternate domain names that are associated with this organization","items":{"type":"string"},"title":"Alternate Domain Names","type":"array"},"ancestor_organization_ids":{"description":"The ancestor organizations, including the parent organization","items":{"type":"string"},"minItems":0,"title":"Ancestor Organizations","type":"array"},"billing_address":{"$ref":"#/components/schemas/Address"},"contact_role_compliance_status":{"enum":["in compliance","not in compliance"],"title":"Contact Role Compliance Status","type":"string"},"contact_role_compliance_violations":{"items":{"additionalProperties":false,"properties":{"compliance_value":{"format":"float","title":"Compliance Value","type":"number"},"contact_role_id":{"title":"Contact Role","type":"string"},"contact_role_name":{"title":"Contact Role Name","type":"string"},"number_of_contacts":{"format":"float","title":"Number Of Contacts","type":"number"},"violation_type":{"enum":["too few","too many"],"title":"Violation Type","type":"string"}},"required":["compliance_value","contact_role_id","number_of_contacts","violation_type"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date_profile_last_updated":{"description":"The date that this organization profile was last updated","format":"date-time","title":"Date Profile Last Updated","type":"string"},"description":{"description":"A description of the organization","title":"Description","type":"string"},"domain_name":{"title":"Domain Name","type":"string"},"facebook":{"description":"Url to the organization's Facebook account","title":"Facebook","type":"string"},"fax_phone_number":{"description":"The fax phone number","title":"Fax Phone Number","type":"string"},"flags":{"description":"Flags that indicate what type of organization this is","items":{"type":"string"},"title":"Flags","type":"array"},"id":{"description":"The unique, string identifier of this organization","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"linked_in":{"description":"Url to the organization's LinkedIn account","title":"LinkedIn","type":"string"},"logo_url":{"description":"Url of a logo for this organization","title":"Logo Url","type":"string"},"main_phone_number":{"description":"The primary phone number","title":"Main Phone Number","type":"string"},"name":{"description":"The name of the organization","title":"Name","type":"string"},"notes":{"description":"Any organization notes","title":"Notes","type":"string"},"number":{"description":"The contact number","format":"float","title":"Number","type":"number"},"number_of_ancestors":{"description":"The number of ancestors this organization has","format":"float","title":"Number Of Ancestors","type":"number"},"other_addresses":{"items":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"type_id":{"description":"The address type","title":"Type","type":"string"}},"required":["address","type_id"],"type":"object"},"type":"array"},"other_phone_numbers":{"items":{"additionalProperties":false,"properties":{"phone_number":{"description":"The phone number","title":"Phone Number","type":"string"},"type_id":{"description":"The phone number type","title":"Type","type":"string"}},"required":["phone_number","type_id"],"type":"object"},"type":"array"},"override_automatic_region_assignment":{"description":"If true, the region assignment for this record is overridden and should not be automatically assigned","title":"Override Automatic Region Assignment","type":"boolean"},"parent_organization_id":{"description":"The parent organization of this one","title":"Parent Organization","type":"string"},"region_id":{"description":"The region","title":"Region","type":"string"},"status":{"description":"The status of the organization record","enum":["active","duplicate","inactive"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_city":{"description":"Search field, internal use only","title":"Sys Search City","type":"string"},"sys_search_city_lower":{"description":"Search field, internal use only","title":"Sys Search City Lower","type":"string"},"sys_search_domain_name":{"description":"Search field, internal use only","title":"Sys Search Domain Name","type":"string"},"sys_search_name":{"description":"Search field, internal use only","title":"Sys Search Name","type":"string"},"sys_search_state":{"description":"Search field, internal use only","title":"Sys Search State","type":"string"},"sys_search_state_lower":{"description":"Search field, internal use only","title":"Sys Search State Lower","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tax_exempt":{"description":"Whether or not this organization is tax exempt","title":"Tax Exempt","type":"boolean"},"top_level_organization_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The top level organization; which is the last entry in the ancestor_organization_ids array"},"children":[]}]}]}],"title":"Top Level Organization","type":"string"},"twitter":{"description":"Url to the organization's Twitter account","title":"Twitter","type":"string"},"type_id":{"description":"The organization type","title":"Type","type":"string"},"website":{"description":"The url of the organization website","title":"Website","type":"string"}},"required":["contact_role_compliance_violations","name","number","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/OrganizationDirectory":{"id":"components/schemas/OrganizationDirectory","kind":"json-schema","title":"OrganizationDirectory","data":{"additionalProperties":false,"properties":{"additional_fields":{"description":"These are additional fields that should be in the directory query, which will be available in the search results","items":{"type":"string"},"title":"Additional Fields","type":"array"},"comment_options":{"additionalProperties":false,"properties":{"comments_header_text":{"description":"The text shown in the header of the comments section","title":"Comments Header Text","type":"string"},"comments_instructions":{"description":"Instructions given to those submitting comments","title":"Comments Instructions","type":"string"},"comments_placeholder_text":{"description":"The placeholder text for the comments","title":"Comments Placeholder Text","type":"string"},"enable_ratings":{"description":"If set, users can rate","title":"Enable Ratings","type":"boolean"},"hide_submitter_name":{"description":"If set, comment submitter names are hidden from the directory","title":"Hide Submitter Name","type":"boolean"},"leave_comment_button_text":{"description":"The button text for Leave Comment","title":"Leave Comment Button Text","type":"string"},"max_rating":{"description":"The maximum rating","format":"float","maximum":10,"minimum":1,"oneOf":[{"x-required":true}],"title":"Max Rating","type":"number"},"no_comments_text":{"description":"The text shown when no comments are present","title":"No Comments Text","type":"string"},"rating_label":{"description":"The label for the rating","title":"Rating Label","type":"string"},"save_comment_button":{"description":"The button text for saving a comment","title":"Save Comment Button","type":"string"}},"title":"Comment Options","type":"object"},"custom_directory_entry_template":{"title":"Custom Directory Entry Template","type":"string"},"custom_search_results_template":{"title":"Custom Search Results Template","type":"string"},"custom_sort_fields":{"items":{"additionalProperties":false,"properties":{"descending":{"title":"Descending","type":"boolean"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"directory_entry_mode":{"enum":["custom","do not show","use default"],"title":"Directory Entry Mode","type":"string"},"display_mode":{"description":"The way that the directory should be displayed","enum":["list","search"],"title":"Display Mode","type":"string"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Criteria","type":"object"},"enable_comments":{"description":"If set, users are allowed to submit comments in the directory","title":"Enable Comments","type":"boolean"},"enable_custom_search_results_template":{"description":"If set, a custom search results template is displayed","title":"Enable Custom Search Results Template","type":"boolean"},"enable_custom_sorting":{"description":"If true, the directory results will be sorted differently that the query","title":"Enable Custom Sorting","type":"boolean"},"enable_eligibility_criteria":{"description":"If set, only certain people can access this directory","title":"Enable Eligibility Criteria","type":"boolean"},"enable_messaging":{"description":"When true, users are able to contact other users through the directory","title":"Enable Messaging","type":"boolean"},"enable_query_expression_filter":{"description":"If set to true, an expression can be used to further filter the query","title":"Enable Query Expression Filter","type":"boolean"},"enable_query_filter":{"description":"If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used","title":"Enable Query Filter","type":"boolean"},"enable_radius_search":{"description":"If true, the user can search across zip code radius","title":"Enable Radius Search","type":"boolean"},"id":{"description":"The unique, string identifier of this organization directory","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this directory is active","title":"Is Active","type":"boolean"},"is_public":{"description":"If true, this is a public directory that can be accessed without security","title":"Is Public","type":"boolean"},"name":{"description":"The name of the organization directory","title":"Name","type":"string"},"page_size":{"description":"The page size, used for server side page and to combat scraping attacks","format":"float","maximum":50,"minimum":1,"title":"Page Size","type":"number"},"query_filter_expression":{"description":"The expression to use to filter the directory","title":"Query Filter Expression","type":"string"},"query_filter_rules":{"title":"Query Filter Rules","type":"object"},"radius_search_options":{"additionalProperties":false,"properties":{"postal_code_field":{"description":"The field to use as the basis for a radius search","title":"Postal Code Field","type":"string"},"radius_options":{"description":"The various default radius that can be selected","items":{"format":"float","type":"number"},"minItems":1,"title":"Radius Options","type":"array"}},"required":["postal_code_field","radius_options"],"title":"Radius Search Options","type":"object"},"refresh_period":{"description":"The period of time (in minutes) after which the directory should refresh it self","format":"float","minimum":5,"title":"Refresh Period","type":"number"},"searchable_fields":{"description":"The fields in the directory that are displayed as search criteria","items":{"additionalProperties":false,"properties":{"group_name":{"description":"The group/display label","title":"Group Name","type":"string"},"label":{"description":"The label that the field should be displayed","title":"Label","type":"string"},"name":{"description":"The field name","title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["custom_directory_entry_template","custom_search_results_template","custom_sort_fields","eligibility_criteria","id","name","query_filter_expression","radius_search_options","searchable_fields","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/OrganizationDuplicate":{"id":"components/schemas/OrganizationDuplicate","kind":"json-schema","title":"OrganizationDuplicate","data":{"properties":{"address_postal_code":{"description":"The address postal code of the organization","title":"Address Postal Code","type":"string"},"domain_name":{"description":"Domain names that are associated with this organization","title":"Domain Name","type":"string"},"facebook":{"description":"Url to the organization's Facebook account","title":"Facebook","type":"string"},"highest_confidence":{"description":"The highest confidence score within the possible duplicates excluding whitelisted records","format":"float","title":"Highest Confidence","type":"number"},"id":{"description":"The unique, string identifier of this organization","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"linked_in":{"description":"Url to the organization's LinkedIn account","title":"Linked In","type":"string"},"main_phone_number":{"description":"The primary phone number","title":"Main Phone Number","type":"string"},"manual_duplicates":{"description":"The IDs of contacts that have been manually identified as duplicates of this contact","items":{"type":"string"},"title":"Manual Duplicates","type":"array"},"name":{"description":"The name of the organization","title":"Name","type":"string"},"name_metaphones":{"description":"The metaphones calculated from the organization's name","items":{"type":"string"},"title":"Name Metaphones","type":"array"},"name_primary_metaphone":{"description":"The primary metaphone calculated from the organization's name","title":"Name Primary Metaphone","type":"string"},"name_secondary_metaphone":{"description":"The secondary metaphone calculated from the organization's name","title":"Name Secondary Metaphone","type":"string"},"number_of_possible_duplicates":{"description":"The number of possible duplicates excluding whitelisted records","format":"float","title":"Number Of Possible Duplicates","type":"number"},"parent_organization_id":{"description":"The parent organization of this one","title":"Parent Organization","type":"string"},"possible_duplicates":{"description":"The organizations that are potentially duplicates of this organization","items":{"properties":{"confidence":{"description":"The likelihood that these two organizations are duplicates on a scale of 1 to 100","format":"float","title":"Confidence","type":"number"},"match":{"description":"The ID of a organization that is potentially a duplicate of this organization","title":"Match","type":"string"}},"required":["confidence","match"],"type":"object"},"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"twitter":{"description":"Url to the organization's Twitter account","title":"Twitter","type":"string"},"website":{"description":"The url of the organization website","title":"Website","type":"string"},"whitelist":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IDs of organizations that have been manually identified as not duplicates of this organization. These IDs may appear in the possible_duplicates array but should not be presented"},"children":[]}]}]}],"items":{"type":"string"},"title":"Whitelist","type":"array"}},"required":["id","manual_duplicates","name","possible_duplicates","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","whitelist"],"type":"object"}},"components/schemas/OrganizationDuplicateCheck":{"id":"components/schemas/OrganizationDuplicateCheck","kind":"json-schema","title":"OrganizationDuplicateCheck","data":{"properties":{"address_postal_code":{"description":"The address postal code of the organization","title":"Address Postal Code","type":"string"},"domain_name":{"description":"Domain names that are associated with this organization","title":"Domain Name","type":"string"},"facebook":{"description":"Url to the organization's Facebook account","title":"Facebook","type":"string"},"linked_in":{"description":"Url to the organization's LinkedIn account","title":"Linked In","type":"string"},"main_phone_number":{"description":"The primary phone number","title":"Main Phone Number","type":"string"},"minimum_confidence":{"description":"The minimum degree of confidence on a scale of 1 to 100 that you would like considered a potential duplicate","format":"float","title":"Minimum Confidence","type":"number"},"name":{"description":"The name of the organization","title":"Name","type":"string"},"parent_organization_id":{"description":"The parent organization of this one","title":"Parent Organization","type":"string"},"twitter":{"description":"Url to the organization's Twitter account","title":"Twitter","type":"string"},"website":{"description":"The url of the organization website","title":"Website","type":"string"}},"required":["name"],"type":"object"}},"components/schemas/OrganizationSearchParameters":{"id":"components/schemas/OrganizationSearchParameters","kind":"json-schema","title":"OrganizationSearchParameters","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"domain_name":{"description":"The domain name","title":"Domain Name","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"description":"The name","title":"Name","type":"string"},"number":{"items":{"format":"float","type":"number"},"title":"Number","type":"array"},"state":{"description":"The state","title":"State","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"type_id":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/OrganizationSearchResults":{"id":"components/schemas/OrganizationSearchResults","kind":"json-schema","title":"OrganizationSearchResults","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"domain_name":{"description":"The domain name","title":"Domain Name","type":"string"},"id":{"title":"ID","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"state":{"description":"The state","title":"State","type":"string"},"status":{"title":"Status","type":"string"},"type_id":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/OrganizationSocialProfile":{"id":"components/schemas/OrganizationSocialProfile","kind":"json-schema","title":"OrganizationSocialProfile","data":{"additionalProperties":false,"properties":{"bio":{"description":"Bio/Notes","title":"Bio","type":"string"},"category":{"description":"Category","title":"Category","type":"string"},"details":{"additionalProperties":false,"properties":{"locations":{"items":{"additionalProperties":false,"properties":{"addressLine1":{"title":"Addressline1","type":"string"},"city":{"title":"City","type":"string"},"country":{"title":"Country","type":"string"},"countryCode":{"title":"Countrycode","type":"string"},"formatted":{"title":"Formatted","type":"string"},"label":{"title":"Label","type":"string"},"postalCode":{"title":"Postalcode","type":"string"},"region":{"title":"Region","type":"string"},"regionCode":{"title":"Regioncode","type":"string"}},"type":"object"},"type":"array"},"phones":{"items":{"additionalProperties":false,"properties":{"label":{"title":"Label","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"}},"title":"Details","type":"object"},"employees":{"description":"Number of employees","format":"float","title":"Employees","type":"number"},"facebook":{"description":"Facebook url","title":"Facebook","type":"string"},"founded":{"description":"Year founded","format":"float","title":"Founded","type":"number"},"linkedin":{"description":"Linked in Profile","title":"Linkedin","type":"string"},"locale":{"description":"Organization locale","title":"Locale","type":"string"},"location":{"description":"Location of the organization","title":"Location","type":"string"},"logo":{"description":"The logo","title":"Logo","type":"string"},"name":{"description":"Name of the organization","title":"Name","type":"string"},"twitter":{"description":"Twitter handle","title":"Twitter","type":"string"}},"type":"object"}},"components/schemas/OrganizationType":{"id":"components/schemas/OrganizationType","kind":"json-schema","title":"OrganizationType","data":{"additionalProperties":false,"properties":{"applicable_contact_role_ids":{"items":{"type":"string"},"minItems":1,"title":"Applicable Contact Roles","type":"array"},"console_create_organization_form_id":{"description":"The default form for creating an organization in the console","pattern":"^rolodex-organizations__.*","title":"Console Create Organization Form","type":"string"},"console_edit_organization_form_id":{"description":"The default form for editing an organization in the console","pattern":"^rolodex-organizations__.*","title":"Console Edit Organization Form","type":"string"},"contact_role_compliance_options":{"additionalProperties":false,"properties":{"contact_role_compliance_rules":{"items":{"additionalProperties":false,"properties":{"contact_role_id":{"description":"The contact role","title":"Contact Role","type":"string"},"maximum":{"description":"The maximum number of contacts, leave blank for unlimited","format":"float","title":"Maximum","type":"number"},"minimum":{"description":"The minimum number; leave blank for 0","format":"float","title":"Minimum","type":"number"}},"required":["contact_role_id"],"type":"object"},"minItems":1,"type":"array"},"notification_options":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email to send to contacts when an organization is out of compliance","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"notification_contact_role_ids":{"description":"The contact role IDs to notify","items":{"type":"string"},"title":"Notification Contact Roles","type":"array"}},"title":"Notification Options","type":"object"},"notify_contacts_of_compliance_violation":{"description":"Whether contacts should be notified of contact compliance violation","title":"Notify Contacts Of Compliance Violation","type":"boolean"}},"required":["contact_role_compliance_rules"],"title":"Contact Role Compliance Options","type":"object"},"enable_contact_role_compliance":{"description":"Whether or not there are rules for how many contacts this organization type can have","title":"Enable Contact Role Compliance","type":"boolean"},"enable_key_roles":{"description":"Allow for creation of key roles","title":"Enable Key Roles","type":"boolean"},"id":{"description":"The unique, string identifier of this organization type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this organization type is active","title":"Is Active","type":"boolean"},"key_roles":{"items":{"additionalProperties":false,"properties":{"role_id":{"title":"Role","type":"string"}},"required":["role_id"],"type":"object"},"minItems":1,"type":"array"},"name":{"description":"The name of the organization type","title":"Name","type":"string"},"portal_create_organization_contact_form_id":{"description":"The form used in the portal when an administrator adds an organization contact","pattern":"^rolodex-contacts__.*","title":"Portal Create Organization Contact Form","type":"string"},"portal_edit_organization_contact_form_id":{"description":"The form used in the portal when an administrator edits an organization contact","pattern":"^rolodex-contacts__.*","title":"Portal Edit Organization Contact Form","type":"string"},"portal_update_organization_info_form_id":{"description":"Update profile portal form","pattern":"^rolodex-organizations__.*","title":"Portal Update Organization Info Form","type":"string"},"restrict_contact_roles":{"description":"If true, only certain contact roles are applicable to organizations of this type","title":"Restrict Contact Roles","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["applicable_contact_role_ids","contact_role_compliance_options","id","key_roles","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PagedContactSearchResults":{"id":"components/schemas/PagedContactSearchResults","kind":"json-schema","title":"PagedContactSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ContactSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedOrganizationSearchResults":{"id":"components/schemas/PagedOrganizationSearchResults","kind":"json-schema","title":"PagedOrganizationSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/OrganizationSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PatchDirective":{"id":"components/schemas/PatchDirective","kind":"json-schema","title":"PatchDirective","data":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"description":"The updated value","title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/PhoneNumberType":{"id":"components/schemas/PhoneNumberType","kind":"json-schema","title":"PhoneNumberType","data":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","contacts","organizations"],"title":"Applies To","type":"string"},"display_order":{"description":"The display order of the type","format":"float","title":"Display Order","type":"number"},"flowdownable":{"description":"If set, the user has the ability to flow down the organization phone numbers to phone numbers of this type","title":"Flowdownable","type":"boolean"},"id":{"description":"The unique, string identifier of this phone number type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this phone number type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the phone number type","title":"Name","type":"string"},"required_in_portal":{"description":"Whether or not this si required in the portal","title":"Required In Portal","type":"boolean"},"show_in_console":{"description":"Whether or not this should be displayed in the console","title":"Show In Console","type":"boolean"},"show_in_portal":{"description":"Whether or not this type should be displayed in the portal","title":"Show In Portal","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PortalSearchParams":{"id":"components/schemas/PortalSearchParams","kind":"json-schema","title":"PortalSearchParams","data":{"additionalProperties":false,"properties":{"email_address":{"description":"The email address to search for matches","title":"Email Address","type":"string"},"first_name":{"description":"The contact's first name","title":"First Name","type":"string"},"last_name":{"description":"The contact's last name","title":"Last Name","type":"string"},"minimum_confidence":{"description":"The minimum degree of confidence on a scale of 1 to 100 that you would like considered a potential duplicate","format":"float","title":"Minimum Confidence","type":"number"},"postal_code":{"description":"The postal code to search for matches","title":"Postal Code","type":"string"}},"type":"object"}},"components/schemas/PortalSearchResults":{"id":"components/schemas/PortalSearchResults","kind":"json-schema","title":"PortalSearchResults","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this contact","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"location":{"additionalProperties":false,"description":"Information off this contact's preferred address masked for data protection","properties":{"city":{"description":"The city of this contact's preferred address","title":"City","type":"string"},"country":{"description":"The country of this contact's preferred address","title":"Country","type":"string"},"state":{"description":"The state of this contact's preferred address","title":"State","type":"string"}},"title":"Location","type":"object"},"masked_email_addresses":{"description":"Email addresses related to this contact masked for data protection","items":{"additionalProperties":false,"properties":{"masked_email_address":{"description":"The masked email address","title":"Masked Email Address","type":"string"},"type":{"description":"The email address type","title":"Type","type":"string"}},"required":["masked_email_address","type"],"type":"object"},"type":"array"},"masked_phone_numbers":{"description":"Phone numbers related to this contact masked for data protection","items":{"additionalProperties":false,"properties":{"masked_phone_number":{"description":"The masked phone number","title":"Masked Phone Number","type":"string"},"type":{"description":"The phone number type","title":"Type","type":"string"}},"required":["masked_phone_number","type"],"type":"object"},"type":"array"},"name":{"description":"The name of the matched contact","title":"Name","type":"string"},"organization_name":{"description":"The name of the organization this contact is related to","title":"Organization Name","type":"string"}},"required":["id","name"],"type":"object"}},"components/schemas/PotentialContactDuplicate":{"id":"components/schemas/PotentialContactDuplicate","kind":"json-schema","title":"PotentialContactDuplicate","data":{"additionalProperties":false,"properties":{"confidence":{"description":"The likelihood that these two contacts are duplicates on a scale of 1 to 100","format":"float","title":"Confidence","type":"number"},"match":{"description":"The ID of the contact that is a potential duplicate","title":"Match","type":"string"}},"required":["confidence","match"],"type":"object"}},"components/schemas/PotentialOrganizationDuplicate":{"id":"components/schemas/PotentialOrganizationDuplicate","kind":"json-schema","title":"PotentialOrganizationDuplicate","data":{"properties":{"confidence":{"description":"The likelihood that these two organizations are duplicates on a scale of 1 to 100","format":"float","title":"Confidence","type":"number"},"match":{"description":"The ID of the organization that is a potential duplicate","title":"Match","type":"string"}},"required":["confidence","match"],"type":"object"}},"components/schemas/PreviewCRCEmailRequest":{"id":"components/schemas/PreviewCRCEmailRequest","kind":"json-schema","title":"PreviewCRCEmailRequest","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"organization_id":{"title":"Organization","type":"string"}},"required":["contact_id","destination_email_address","organization_id"],"type":"object"}},"components/schemas/PublicRead":{"id":"components/schemas/PublicRead","kind":"json-schema","title":"PublicRead","data":{"additionalProperties":false,"properties":{"acronym":{"description":"The acronym for the organization, if applicable","title":"Acronym","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"alt_phone_number":{"description":"The alternative phone number","title":"Alt Phone Number","type":"string"},"alternate_domain_names":{"description":"Alternate domain names that are associated with this organization","items":{"type":"string"},"title":"Alternate Domain Names","type":"array"},"ancestor_organization_ids":{"description":"The ancestor organizations, including the parent organization","items":{"type":"string"},"minItems":0,"title":"Ancestor Organizations","type":"array"},"billing_address":{"$ref":"#/components/schemas/Address"},"contact_role_compliance_status":{"enum":["in compliance","not in compliance"],"title":"Contact Role Compliance Status","type":"string"},"contact_role_compliance_violations":{"items":{"additionalProperties":false,"properties":{"compliance_value":{"format":"float","title":"Compliance Value","type":"number"},"contact_role_id":{"title":"Contact Role","type":"string"},"contact_role_name":{"title":"Contact Role Name","type":"string"},"number_of_contacts":{"format":"float","title":"Number Of Contacts","type":"number"},"violation_type":{"enum":["too few","too many"],"title":"Violation Type","type":"string"}},"required":["compliance_value","contact_role_id","number_of_contacts","violation_type"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date_profile_last_updated":{"description":"The date that this organization profile was last updated","format":"date-time","title":"Date Profile Last Updated","type":"string"},"description":{"description":"A description of the organization","title":"Description","type":"string"},"domain_name":{"title":"Domain Name","type":"string"},"facebook":{"description":"Url to the organization's Facebook account","title":"Facebook","type":"string"},"fax_phone_number":{"description":"The fax phone number","title":"Fax Phone Number","type":"string"},"flags":{"description":"Flags that indicate what type of organization this is","items":{"type":"string"},"title":"Flags","type":"array"},"id":{"description":"The unique, string identifier of this organization","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"linked_in":{"description":"Url to the organization's LinkedIn account","title":"LinkedIn","type":"string"},"logo_url":{"description":"Url of a logo for this organization","title":"Logo Url","type":"string"},"main_phone_number":{"description":"The primary phone number","title":"Main Phone Number","type":"string"},"name":{"description":"The name of the organization","title":"Name","type":"string"},"notes":{"description":"Any organization notes","title":"Notes","type":"string"},"number":{"description":"The contact number","format":"float","title":"Number","type":"number"},"number_of_ancestors":{"description":"The number of ancestors this organization has","format":"float","title":"Number Of Ancestors","type":"number"},"other_addresses":{"items":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"type_id":{"description":"The address type","title":"Type","type":"string"}},"required":["address","type_id"],"type":"object"},"type":"array"},"other_phone_numbers":{"items":{"additionalProperties":false,"properties":{"phone_number":{"description":"The phone number","title":"Phone Number","type":"string"},"type_id":{"description":"The phone number type","title":"Type","type":"string"}},"required":["phone_number","type_id"],"type":"object"},"type":"array"},"override_automatic_region_assignment":{"description":"If true, the region assignment for this record is overridden and should not be automatically assigned","title":"Override Automatic Region Assignment","type":"boolean"},"parent_organization_id":{"description":"The parent organization of this one","title":"Parent Organization","type":"string"},"region_id":{"description":"The region","title":"Region","type":"string"},"status":{"description":"The status of the organization record","enum":["active","duplicate","inactive"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_city":{"description":"Search field, internal use only","title":"Sys Search City","type":"string"},"sys_search_city_lower":{"description":"Search field, internal use only","title":"Sys Search City Lower","type":"string"},"sys_search_domain_name":{"description":"Search field, internal use only","title":"Sys Search Domain Name","type":"string"},"sys_search_name":{"description":"Search field, internal use only","title":"Sys Search Name","type":"string"},"sys_search_state":{"description":"Search field, internal use only","title":"Sys Search State","type":"string"},"sys_search_state_lower":{"description":"Search field, internal use only","title":"Sys Search State Lower","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tax_exempt":{"description":"Whether or not this organization is tax exempt","title":"Tax Exempt","type":"boolean"},"top_level_organization_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The top level organization; which is the last entry in the ancestor_organization_ids array"},"children":[]}]}]}],"title":"Top Level Organization","type":"string"},"twitter":{"description":"Url to the organization's Twitter account","title":"Twitter","type":"string"},"type_id":{"description":"The organization type","title":"Type","type":"string"},"website":{"description":"The url of the organization website","title":"Website","type":"string"}},"required":["contact_role_compliance_violations","name","number","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Region":{"id":"components/schemas/Region","kind":"json-schema","title":"Region","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the region","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this region","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this region is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the region","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/RegionConfiguration":{"id":"components/schemas/RegionConfiguration","kind":"json-schema","title":"RegionConfiguration","data":{"properties":{"default_region_id":{"description":"The default region id to use","title":"Default Region","type":"string"},"name":{"description":"The name of the region configuration","title":"Name","type":"string"},"notes":{"description":"Any notes about this configuration","title":"Notes","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"zones":{"items":{"properties":{"countries":{"items":{"properties":{"country":{"description":"The country","title":"Country","type":"string"}},"required":["country"],"type":"object"},"type":"array"},"enabled":{"description":"Whether or not this zone is enabled","title":"Enabled","type":"boolean"},"id":{"description":"A unique id for the zone","title":"ID","type":"string"},"name":{"description":"The name of the zone","title":"Name","type":"string"},"postal_code_ranges":{"items":{"properties":{"end":{"title":"End","type":"string"},"start":{"title":"Start","type":"string"}},"required":["end","start"],"type":"object"},"type":"array"},"region_id":{"description":"The default product to use for tax","title":"Region","type":"string"},"states":{"items":{"properties":{"state":{"description":"The state","title":"State","type":"string"}},"required":["state"],"type":"object"},"type":"array"},"type":{"enum":["country","postal code","rest of the world","state"],"title":"Type","type":"string"}},"required":["enabled","id","name"],"type":"object"},"type":"array"}},"required":["name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Relationship":{"id":"components/schemas/Relationship","kind":"json-schema","title":"Relationship","data":{"additionalProperties":false,"properties":{"end_date":{"description":"The end of the relationship","title":"End Date","type":"string"},"id":{"description":"The unique, string identifier of this relationship","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"left_side_id":{"description":"The left side of this relationship","title":"Left Side","type":"string"},"left_side_name":{"description":"The name of the item on the left side","title":"Left Side Name","type":"string"},"left_side_type":{"description":"The type of the left side of this relationship","enum":["rolodex-contacts","rolodex-organizations"],"title":"Left Side Type","type":"string"},"name":{"description":"The name of the relationship, calculated automatically","title":"Name","type":"string"},"notes":{"description":"Any notes about the relationship","title":"Notes","type":"string"},"right_side_id":{"description":"The right side of this relationship","title":"Right Side","type":"string"},"right_side_name":{"description":"The name of the item on the right side","title":"Right Side Name","type":"string"},"right_side_type":{"description":"The type of the left side of this relationship","enum":["rolodex-contacts","rolodex-organizations"],"title":"Right Side Type","type":"string"},"start_date":{"description":"The start of the relationship","title":"Start Date","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The relationship type","title":"Type","type":"string"}},"required":["id","left_side_id","left_side_type","right_side_id","right_side_type","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/RelationshipType":{"id":"components/schemas/RelationshipType","kind":"json-schema","title":"RelationshipType","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this relationship type","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this relationship type is active","title":"Is Active","type":"boolean"},"left_side_type":{"description":"The type of the left side of this relationship","enum":["rolodex-contacts","rolodex-organizations"],"title":"Left Side Type","type":"string"},"name":{"description":"The name of the relationship type","title":"Name","type":"string"},"right_side_type":{"description":"The type of the left side of this relationship","enum":["rolodex-contacts","rolodex-organizations"],"title":"Right Side Type","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","left_side_type","name","right_side_type","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"additional_contact_fields_to_show_in_organization_queries":{"description":"RB-3239 - when querying organizations, you can show contacts by role. Besides name/email/phone, you can also have additional fields added. A limit is imposed so that query descriptions do not blow up.","items":{"additionalProperties":false,"properties":{"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"}},"required":["label","name"],"type":"object"},"maxItems":15,"type":"array"},"automatic_region_assignment_options":{"additionalProperties":false,"properties":{"automatically_assign":{"description":"Who should have their regions assigned automatically","enum":["both","contacts","organizations"],"title":"Automatically Assign","type":"string"},"contact_address_type":{"enum":["home","other","preferred","school","work"],"title":"Contact Address Type","type":"string"},"contact_other_address_type_id":{"oneOf":[{"x-required":true}],"title":"Contact Other Address Type","type":"string"},"rules":{"items":{"additionalProperties":false,"properties":{"countries":{"items":{"additionalProperties":false,"properties":{"country":{"description":"The country","title":"Country","type":"string"}},"required":["country"],"type":"object"},"maxItems":1000,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"postal_code_ranges":{"items":{"additionalProperties":false,"properties":{"end":{"title":"End","type":"string"},"start":{"title":"Start","type":"string"}},"required":["end","start"],"type":"object"},"maxItems":1000,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"region_id":{"description":"The region to assign","title":"Region","type":"string"},"states":{"items":{"additionalProperties":false,"properties":{"state":{"description":"The state","title":"State","type":"string"}},"required":["state"],"type":"object"},"maxItems":1000,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"type":{"enum":["country","postal code","rest of the world","state"],"title":"Type","type":"string"}},"required":["region_id","type"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"title":"Automatic Region Assignment Options","type":"object"},"child_organization_portal_settings":{"additionalProperties":false,"properties":{"allow_creation_of_new_child_organization":{"description":"If set, contacts can create child organizations in the portal","title":"Allow Creation Of New Child Organization","type":"boolean"},"allow_deleting_of_child_organization":{"description":"If set, contacts can delete child organizations in the portal","title":"Allow Deleting Of Child Organization","type":"boolean"},"allow_editing_of_child_organization":{"description":"If set, contacts can edit child organizations in the portal","title":"Allow Editing Of Child Organization","type":"boolean"},"child_organization_label_plural":{"description":"Label for describing child organizations in the portal (plural)","title":"Child Organization Label Plural","type":"string"},"child_organization_label_singular":{"description":"Label for describing child organization in the portal","title":"Child Organization Label Singular","type":"string"},"create_organization_form_id":{"description":"The form for new users","oneOf":[{"x-required":true}],"pattern":"^rolodex-organizations__.*","title":"Create Organization Form","type":"string"},"edit_organization_form_id":{"description":"The form for new users","oneOf":[{"x-required":true}],"pattern":"^rolodex-organizations__.*","title":"Edit Organization Form","type":"string"}},"required":["child_organization_label_plural","child_organization_label_singular"],"title":"Child Organization Portal Settings","type":"object"},"committees_to_include_in_contact_queries":{"items":{"additionalProperties":false,"properties":{"additional_fields":{"items":{"type":"string"},"maxItems":10,"title":"Additional Fields","type":"array"},"committee_id":{"description":"The committee that is being linked","title":"Committee","type":"string"}},"required":["committee_id"],"type":"object"},"maxItems":15,"minItems":1,"type":"array"},"console_create_contact_form_id":{"description":"The default form for creating a contact in the console","pattern":"^rolodex-contacts__.*","title":"Console Create Contact Form","type":"string"},"console_create_organization_form_id":{"description":"The default form for creating an organization in the console","pattern":"^rolodex-organizations__.*","title":"Console Create Organization Form","type":"string"},"console_edit_contact_form_id":{"description":"The default form for editing a contact in the console","pattern":"^rolodex-contacts__.*","title":"Console Edit Contact Form","type":"string"},"console_edit_organization_form_id":{"description":"The default form for editing an organization in the console","pattern":"^rolodex-organizations__.*","title":"Console Edit Organization Form","type":"string"},"contact_engagement_scoring_model_id":{"description":"The scoring model for contacts","title":"Contact Engagement Scoring Model","type":"string"},"contact_role_permissions":{"description":"The contact roles that are allowed to manage this scholarship","items":{"additionalProperties":false,"properties":{"create_child_organizations":{"description":"This role can create new child organizations","title":"Create Child Organizations","type":"boolean"},"create_contacts":{"description":"This role can create contacts associated with the organization","title":"Create Contacts","type":"boolean"},"delete_child_organizations":{"description":"This role can delete child organizations","title":"Delete Child Organizations","type":"boolean"},"edit_child_organizations":{"description":"This role can edit child organizations","title":"Edit Child Organizations","type":"boolean"},"edit_contacts":{"description":"This role can edit contacts associated with the organization","title":"Edit Contacts","type":"boolean"},"manage_child_organizations":{"description":"This role can manage child organizations","title":"Manage Child Organizations","type":"boolean"},"remove_contacts":{"description":"This role can remove contacts associated with the organization","title":"Remove Contacts","type":"boolean"},"role_id":{"description":"The contact role","title":"Role","type":"string"},"update_organization_info":{"description":"Contacts in this role are notified any time new contacts are added to their organization","title":"Update Organization Info","type":"boolean"},"view_contacts":{"description":"This role can view contacts associated with the organization","title":"View Contacts","type":"boolean"}},"type":"object"},"type":"array"},"contacts":{"additionalProperties":false,"properties":{"default_360_screen":{"description":"The default 360 screen to show in the console","title":"Default 360 Screen","type":"string"},"default_console_forms":{"additionalProperties":false,"properties":{"creation":{"description":"Default form for creating a contact in the console","title":"Creation","type":"string"},"editing":{"description":"Default form for editing a contact in the console","title":"Editing","type":"string"}},"title":"Default Console Forms","type":"object"},"default_portal_forms":{"additionalProperties":false,"properties":{"add_organization_contact":{"description":"Default form for a contact adding another contact in their organization in the portal","title":"Add Organization Contact","type":"string"},"new_user":{"description":"Default form for a new user in the portal","title":"New User","type":"string"},"update_organization_contact":{"description":"Default form for a contact editing another contact in their organization in the portal","title":"Update Organization Contact","type":"string"},"update_profile":{"description":"Default form for a contact editing themselves in the portal","title":"Update Profile","type":"string"}},"title":"Default Portal Forms","type":"object"}},"title":"Contacts","type":"object"},"courses_to_include_in_contact_queries":{"items":{"additionalProperties":false,"properties":{"additional_fields":{"items":{"type":"string"},"maxItems":10,"title":"Additional Fields","type":"array"},"course_id":{"description":"The course that is being linked","title":"Course","type":"string"}},"required":["course_id"],"type":"object"},"maxItems":15,"minItems":1,"type":"array"},"disable_organization_creation_during_sign_up":{"description":"If set, the sign up contact sign up/linking process will not create an organization","title":"Disable Organization Creation During Sign Up","type":"boolean"},"duplicate_prevention":{"description":"If set, contacts will not be allowed to be created/updated with a duplicate email address","enum":["both","disabled","portal"],"title":"Duplicate Prevention","type":"string"},"enable_automatic_region_assignment":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set, contacts & organizations are assigned to a region"},"children":[]}]}]}],"title":"Enable Automatic Region Assignment","type":"boolean"},"enable_child_organization_management_in_portal":{"description":"If true, contacts can manage child organizations in the portal","title":"Enable Child Organization Management In Portal","type":"boolean"},"enable_engagement_scoring":{"description":"Whether or not engagement scoring is enabled","title":"Enable Engagement Scoring","type":"boolean"},"events_to_include_in_contact_queries":{"items":{"additionalProperties":false,"properties":{"additional_fields":{"items":{"type":"string"},"maxItems":10,"title":"Additional Fields","type":"array"},"event_id":{"description":"The event that is being linked","title":"Event","type":"string"}},"required":["event_id"],"type":"object"},"maxItems":15,"minItems":1,"type":"array"},"include_committee_fields_in_contact_queries":{"description":"If set, committee-related fields for certain committees will be included in all contact queries","title":"Include Committee Fields In Contact Queries","type":"boolean"},"include_course_fields_in_contact_queries":{"description":"If set, course-related fields for certain courses will be included in all contact queries","title":"Include Course Fields In Contact Queries","type":"boolean"},"include_event_fields_in_contact_queries":{"description":"If set, event-related fields for certain events will be included in all contact queries","title":"Include Event Fields In Contact Queries","type":"boolean"},"new_contact_redirect_route":{"description":"If set, the route that new contacts should be taken to after contact creation","title":"New Contact Redirect Route","type":"string"},"notes":{"title":"Notes","type":"string"},"organization_engagement_scoring_model_id":{"description":"The scoring model for organizations","title":"Organization Engagement Scoring Model","type":"string"},"organizations":{"additionalProperties":false,"properties":{"default_360_screen":{"description":"The default 360 screen to show in the console","title":"Default 360 Screen","type":"string"},"default_console_forms":{"additionalProperties":false,"properties":{"creation":{"description":"Default form for creating a organization in the console","title":"Creation","type":"string"},"editing":{"description":"Default form for editing a organization in the console","title":"Editing","type":"string"}},"title":"Default Console Forms","type":"object"},"default_portal_forms":{"additionalProperties":false,"properties":{"editing":{"description":"Default form for editing one's organization in the console","title":"Editing","type":"string"}},"title":"Default Portal Forms","type":"object"}},"title":"Organizations","type":"object"},"portal_create_organization_contact_form_id":{"description":"The form used in the portal when an administrator adds an organization contact","pattern":"^rolodex-contacts__.*","title":"Portal Create Organization Contact Form","type":"string"},"portal_edit_organization_contact_form_id":{"description":"The form used in the portal when an administrator edits an organization contact","pattern":"^rolodex-contacts__.*","title":"Portal Edit Organization Contact Form","type":"string"},"portal_new_user_profile_form_id":{"description":"The form for new users","pattern":"^rolodex-contacts__.*","title":"Portal New User Profile Form","type":"string"},"portal_update_organization_info_form_id":{"description":"Update profile portal form","pattern":"^rolodex-organizations__.*","title":"Portal Update Organization Info Form","type":"string"},"portal_update_profile_form_id":{"description":"Update profile portal form","pattern":"^rolodex-contacts__.*","title":"Portal Update Profile Form","type":"string"},"restrict_contact_credentials_changes":{"description":"If set, contacts cannot change their credentials in the portal","title":"Restrict Contact Credentials Changes","type":"boolean"},"restrict_contact_name_changes":{"description":"If set, contacts cannot change their name in the portal","title":"Restrict Contact Name Changes","type":"boolean"},"restrict_organization_name_changes":{"description":"If set, contacts cannot change their organization's name in the portal","title":"Restrict Organization Name Changes","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["automatic_region_assignment_options","child_organization_portal_settings","committees_to_include_in_contact_queries","courses_to_include_in_contact_queries","events_to_include_in_contact_queries","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/SocialProfile":{"id":"components/schemas/SocialProfile","kind":"json-schema","title":"SocialProfile","data":{"additionalProperties":false,"properties":{"avatar":{"description":"A url of the image of the individual","title":"Avatar","type":"string"},"bio":{"description":"Bio/Notes","title":"Bio","type":"string"},"details":{"additionalProperties":false,"properties":{},"title":"Details","type":"object"},"emailAddress":{"description":"The primary email address","title":"Emailaddress","type":"string"},"facebook":{"description":"Facebook url","title":"Facebook","type":"string"},"fullName":{"description":"The full name","title":"Fullname","type":"string"},"gender":{"description":"The discovered gender","enum":["female","male"],"title":"Gender","type":"string"},"linkedin":{"description":"Linked in Profile","title":"Linkedin","type":"string"},"organization":{"description":"The organization the contact belongs to","title":"Organization","type":"string"},"title":{"description":"The job title","title":"Title","type":"string"},"twitter":{"description":"Twitter handle","title":"Twitter","type":"string"}},"type":"object"}},"components/schemas/StandardQueryDefinition":{"id":"components/schemas/StandardQueryDefinition","kind":"json-schema","title":"StandardQueryDefinition","data":{"additionalProperties":false,"properties":{"category":{"title":"Category","type":"string"},"definition":{"additionalProperties":false,"properties":{},"title":"Definition","type":"object"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/Statistic":{"id":"components/schemas/Statistic","kind":"json-schema","title":"Statistic","data":{"additionalProperties":false,"properties":{"dataSource":{"description":"The datasource used to generate this value","title":"Datasource","type":"string"},"error":{"description":"If the cache encountered an error, this is it","title":"Error","type":"string"},"id":{"description":"The unique, string identifier of this statistic","pattern":"^[\\w-:%\\/]+$","title":"ID","type":"string"},"name":{"description":"The name of the statistic","title":"Name","type":"string"},"status":{"description":"The description of the statistic","enum":["error","processing","valid"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"value":{"description":"The numeric value of the statistic","format":"float","title":"Value","type":"number"},"value_difference_numeric":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the numeric difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Numeric","type":"number"},"value_difference_percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the percentage difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Percentage","type":"number"},"value_for_previous_period":{"description":"For statistics that can compare values from a previous period, this is the value","format":"float","title":"Value For Previous Period","type":"number"},"values":{"description":"If the stat hs values in a row form, this variable contains it","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"required":["id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","value"],"type":"object"}},"components/schemas/StepFunctionExecutionToken":{"id":"components/schemas/StepFunctionExecutionToken","kind":"json-schema","title":"StepFunctionExecutionToken","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The arn of the execution","title":"Executionarn","type":"string"},"notification_channel":{"description":"The id of the channel where progress updates will be posted","title":"Notification Channel","type":"string"},"notification_publishKey":{"description":"The publish key for the channel where progress updates will be posted","title":"Notification Publishkey","type":"string"},"notification_subscribeKey":{"description":"The subscribe key for the channel where progress updates will be posted","title":"Notification Subscribekey","type":"string"},"start_date":{"description":"The start date of the execution","format":"date-time","title":"Start Date","type":"string"}},"required":["executionArn"],"type":"object"}},"schema_591":{"kind":"json-schema","data":{"type":"string"},"id":"schema_591"},"schema_592":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AccountDelegationProcess"},"type":"array"},"id":"schema_592"},"schema_593":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_593"},"schema_594":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AddressType"},"type":"array"},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CommunicationType"},"type":"array"},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContactDirectory"},"type":"array"},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"type":"object"},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContactDuplicate"},"type":"array"},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PotentialContactDuplicate"},"type":"array"},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PortalSearchResults"},"type":"array"},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContactRoleRuleSet"},"type":"array"},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContactRole"},"type":"array"},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"id":"schema_604"},"schema_605":{"kind":"json-schema","data":{"properties":{"returnUrl":{"type":"string"}},"type":"object"},"id":"schema_605"},"schema_606":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CustomActivity"},"type":"array"},"id":"schema_606"},"schema_607":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CustomActivityType"},"type":"array"},"id":"schema_607"},"schema_608":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CustomEngagementMetric"},"type":"array"},"id":"schema_608"},"schema_609":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/EngagementCategory"},"type":"array"},"id":"schema_609"},"schema_610":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/EngagementModel"},"type":"array"},"id":"schema_610"},"schema_611":{"kind":"json-schema","data":{"type":"string","enum":["contact","organization"]},"id":"schema_611"},"schema_612":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OrganizationDirectory"},"type":"array"},"id":"schema_612"},"schema_613":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OrganizationDuplicate"},"type":"array"},"id":"schema_613"},"schema_614":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PotentialOrganizationDuplicate"},"type":"array"},"id":"schema_614"},"schema_615":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OrganizationType"},"type":"array"},"id":"schema_615"},"schema_616":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array"},"id":"schema_616"},"schema_617":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PhoneNumberType"},"type":"array"},"id":"schema_617"},"schema_618":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Region"},"type":"array"},"id":"schema_618"},"schema_619":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RelationshipType"},"type":"array"},"id":"schema_619"},"schema_620":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_620"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/rolodex/rolodex-v1","isMockServer":true,"description":"Mock server"},{"url":"https://rolodex.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/rolodex/rolodex-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/rolodex/rolodex-v1.json?download"},{"url":"/_bundle/apis/rolodex/rolodex-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Rolodex (Contacts & Organizations)","description":"The Contacts & Organizations, or Rolodex, app provides the Customer Relationship Management (CRM) capabilities\nof the Rhythm platform. Common integrations with the Rolodex API include finding or updating contact information, \ndemographics, or communication preferences for a Contact or Organization.\n\nLike most of the other Rhythm apps, the Rolodex API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API.\n"}},"baseSlug":"/apis/rolodex/rolodex-v1","routesMapping":{}}