Starfish API Documentation

createAccountHolder

Creates a new account holder.

CreateAccountHolderMutationInput

Autogenerated input type of CreateAccountHolderMutation

  • clientMutationId: String

    A unique identifier for the client performing the mutation.

  • firstName: String!required

  • lastName: String!required

  • dateOfBirth: ISO8601Date

  • phoneNumber: String

  • emailAddress: String!required

  • sendWelcomeEmail: Booleandefault true

  • consentsToMarketing: Booleandefault false

  • serviceStoreId: ID

    The service store preferred by the user

  • pmsPatientIdentifier: String

  • personalIdentityNumber: String

CreateAccountHolderMutationPayload

Autogenerated return type of CreateAccountHolderMutation.

Query

mutation CreateAccountHolder($input: CreateAccountHolderMutationInput!) {
  createAccountHolder(input: $input) {
    accountHolder {
      id
      firstName
      lastName
      emailAddress
      dateOfBirth
      phoneNumber
      creationDate
      url
      personalIdentityNumber
      serviceStore {
        id
        name
      }
    }
    errors {
      message
      path
    }
  }
}

Variables

{
  "input": {
    "emailAddress": "nathan+1@example.com",
    "firstName": "Peter",
    "lastName": "Jost",
    "phoneNumber": "0123456789",
    "dateOfBirth": "1991-05-20",
    "consentsToMarketing": true,
    "serviceStoreId": "Location-G9LT2699KD6",
    "pmsPatientIdentifier": "1234567890",
    "personalIdentityNumber": "12345"
  }
}

Response

{
  "data": {
    "createAccountHolder": {
      "accountHolder": {
        "id": "AccountHolder-42QF3KP37NW",
        "firstName": "Peter",
        "lastName": "Jost",
        "emailAddress": "nathan+1@example.com",
        "dateOfBirth": "1991-05-20",
        "phoneNumber": "0123456789",
        "creationDate": "2021-05-20T07:00:00-05:00",
        "url": "http://acme.platform.localhost:3000/en-US/users/42QF3KP37NW",
        "personalIdentityNumber": "12345",
        "serviceStore": {
          "id": "Location-G9LT2699KD6",
          "name": "James Road"
        }
      },
      "errors": []
    }
  }
}