> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.beanrails.com/llms.txt > Use this file to discover all available pages before exploring further. # Add an address to a contact > Setting `is_primary` to true demotes the contact's current primary address. Requires the `contacts:write` scope. ## OpenAPI ````yaml /openapi.yaml post /contacts/{contactId}/addresses openapi: 3.1.0 info: title: BeanRails Public API version: 1.0.0 description: > Read and write BeanRails contacts, works, invoices, quotations and invoice payments from your own systems. Authenticate every request with an API key. See the guides for scopes, pagination and error handling. servers: - url: https://{host}/api/public/v1 description: Public API v1 variables: host: default: app.beanrails.com description: The host your BeanRails workspace is served from. security: - bearerAuth: [] tags: - name: Contacts description: Customers and leads. - name: Contact addresses description: Billing, shipping and service addresses of a contact. - name: Works description: Service or delivery jobs. - name: Work PODs description: Proof of delivery records submitted by drivers (read only). - name: Invoices description: Invoices, including status changes. - name: Quotations description: Quotations, including status changes. - name: Invoice payments description: Payments recorded against an invoice. paths: /contacts/{contactId}/addresses: parameters: - $ref: '#/components/parameters/ContactId' post: tags: - Contact addresses summary: Add an address to a contact description: > Setting `is_primary` to true demotes the contact's current primary address. Requires the `contacts:write` scope. operationId: createContactAddress requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ContactAddressInput' responses: '200': description: The created address. content: application/json: schema: $ref: '#/components/schemas/ContactAddressEnvelope' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/RateLimited' components: parameters: ContactId: name: contactId in: path required: true description: The contact ID. schema: type: integer schemas: ContactAddressInput: type: object required: - name - is_primary properties: name: type: string maxLength: 255 description: A label for the address, such as "Head office". attention: type: string email: type: string format: email company_name: type: string mobile_no: type: string office_no: type: string address1: type: string address2: type: string city: type: string state: type: string description: A state name known to BeanRails. postcode: type: string country: type: string description: Two letter country code, for example `MY`. zone_id: type: integer is_primary: type: boolean description: >- Required on the address endpoints. When creating a contact, the first address becomes primary. ContactAddressEnvelope: type: object properties: data: $ref: '#/components/schemas/ContactAddress' ContactAddress: type: object additionalProperties: true properties: id: type: integer name: type: string attention: type: - string - 'null' email: type: - string - 'null' company_name: type: - string - 'null' mobile_no: type: - string - 'null' office_no: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' postcode: type: - string - 'null' country: type: - string - 'null' description: Two letter country code. country_name: type: - string - 'null' zone_id: type: - integer - 'null' is_primary: type: boolean Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: A stable, machine readable code. examples: - not_found message: type: string description: A human readable explanation. ValidationError: type: object required: - error properties: error: type: object required: - code - message - fields properties: code: type: string enum: - validation_failed message: type: string fields: type: object description: Field names mapped to a list of messages. additionalProperties: type: array items: type: string responses: Unauthorized: description: The API key is missing, invalid, revoked or expired. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: invalid_api_key message: The API key is invalid, revoked, or expired. Forbidden: description: >- The key lacks the required scope, the key owner's role no longer allows it, or the owner's account is suspended. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: insufficient_scope message: This API key does not have the required scope. NotFound: description: The record does not exist, or your key is not allowed to see it. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: not_found message: The requested resource was not found. ValidationFailed: description: >- The request body failed validation. `error.fields` lists the problems per field. content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: error: code: validation_failed message: The attention field is required. fields: attention: - The attention field is required. RateLimited: description: >- You exceeded the key's requests per minute. Wait for the number of seconds in the `Retry-After` header. headers: Retry-After: description: Seconds until you can retry. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer description: An API key created in BeanRails, for example `brk_live_...`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.