setCustomAttributesOnCompany mutation

The setCustomAttributesOnCompany mutation sets custom attributes on a company. The mutation accepts a company ID and an array of custom attribute key/value pairs. It returns the updated Company object. All ID values are treated as strings.

To remove a custom attribute, rerun the mutation without the previously applied custom attribute.

Syntax

Copy
mutation {
  setCustomAttributesOnCompany(
    input: SetCustomAttributesOnCompanyInput
  ){    
    SetCustomAttributesOnCompanyOutput
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCompany(
    input: SetCustomAttributesOnCompanyInput
  ){    
    SetCustomAttributesOnCompanyOutput
  }
}

Reference

The setCustomAttributesOnCompany reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example sets two custom attributes on a company.

Request:

Copy
mutation {
  setCustomAttributesOnCompany(
    input: {
      company_id: "MQ=="
      custom_attributes: [
        {
          attribute_code: "attribute_one"
          value: "value_one"
        },
        {
          attribute_code: "attribute_two"
          value: "value_two"
        }
      ]
    }
  ) {
    company {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCompany(
    input: {
      company_id: "MQ=="
      custom_attributes: [
        {
          attribute_code: "attribute_one"
          value: "value_one"
        },
        {
          attribute_code: "attribute_two"
          value: "value_two"
        }
      ]
    }
  ) {
    company {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "setCustomAttributesOnCompany": {
      "company": {
        "id": "MQ==",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setCustomAttributesOnCompany": {
      "company": {
        "id": "MQ==",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}

Last updated 6/10/2025

Was this helpful?

Yes

No