Accounting

Creates contacts to a specific contact group

put/ContactGroups/{ContactGroupID}/Contacts

Path parameters

ContactGroupIDstring uuid required

Unique identifier for a Contact Group

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

Example request

{
  "Contacts": [
    {
      "UpdatedDateUTC": "/Date(1573755038314)/",
      "BrandingTheme": {
        "CreatedDateUTC": "/Date(1573755038314)/"
      },
      "BatchPayments": {
        "BankAccountNumber": "123-456-1111111",
        "BankAccountName": "ACME Bank",
        "Details": "Hello World",
        "Code": "ABC",
        "Reference": "Foobar"
      },
      "Attachments": [
        {
          "AttachmentID": "00000000-0000-0000-0000-000000000000",
          "FileName": "xero-dev.jpg",
          "Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
          "MimeType": "image/jpg"
        }
      ]
    }
  ]
}

Response

Success - return response of type Contacts array of added Contacts

Example response

{
  "Contacts": [
    {
      "UpdatedDateUTC": "/Date(1573755038314)/",
      "BrandingTheme": {
        "CreatedDateUTC": "/Date(1573755038314)/"
      },
      "BatchPayments": {
        "BankAccountNumber": "123-456-1111111",
        "BankAccountName": "ACME Bank",
        "Details": "Hello World",
        "Code": "ABC",
        "Reference": "Foobar"
      },
      "Attachments": [
        {
          "AttachmentID": "00000000-0000-0000-0000-000000000000",
          "FileName": "xero-dev.jpg",
          "Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
          "MimeType": "image/jpg"
        }
      ]
    }
  ]
}

Changes

Changed in 2 of the 58 revisions of this API.4

Sep 15, 2025ab9dba3c87462See the full diff
- ○
  added the new optional request property Contacts/items/TaxNumberType
  new-optional-request-property
- ○
  added the optional property Contacts/items/TaxNumberType to the response with the 200 status
  response-optional-property-added
Jul 29, 202498ef773227e52See the full diff
- ○
  added the new optional request property Warnings
  new-optional-request-property
- ○
  added the optional property Warnings to the response with the 200 status
  response-optional-property-added

Full history