share_fields

Create one or more field shares.

Input fields

email_address (String!)

An email address for the person that you would like to share the fields with.

field_sentera_ids ([ID!]!)

System-generated keys identifying specific fields to share.

notify_recipient (Boolean)

Should the recipient of the shares be notified that a field has been shared with them? Defaults to true.

Return fields

fields ([SharedField!]!)

A list of statuses for the shared fields

Examples

Share Fields

Shares one or more fields with one person. The person can be an existing FieldAgent user or someone that does not have a FieldAgent account. The example below shows a GraphQL mutation that attempts to share two fields with one person. One field that exists and one that does not exist. The request to share the fields partially succeeds. The field that exists is is successfully shared while the other field that does not exist returns an error stating the field is not found.

Try this example in GraphiQL
mutation ShareFields {
  share_fields(
  field_sentera_ids: ["zx0tsts_AS_SHORT1_CV_test_1ba88e5_170907_220547", "i_do_not_exist_123"]
  email_address: "any-email-here@example.com"
  ){
  fields {
    field_sentera_id
    status
    errors
  }
  }
}

{
  "data": {
  "share_fields": {
    "fields": [
      {
        "field_sentera_id": "zx0tsts_AS_SHORT1_CV_test_1ba88e5_170907_220547",
        "status": "SUCCESS"
      },
      {
        "field_sentera_id": "i_do_not_exist_123",
        "status": "ERROR",
        "errors": [
          "Field not found"
        ]
      }
    ]
  }
  }
}