Creates a single TeamMember object. The TeamMember object is returned on successful creates.
You must provide the following values in your request to this endpoint:
given_namefamily_name
Learn about .
643 matches
100 actions
Square Connect
100 actions
Other/Square Connect
Creates a single TeamMember object. The TeamMember object is returned on successful creates.
You must provide the following values in your request to this endpoint:
given_namefamily_nameLearn about .
{
"type": "object",
"description": "Represents a create request for a `TeamMember` object.",
"properties": {
"idempotency_key": {
"type": "string",
"description": "A unique string that identifies this `CreateTeamMember` request.\nKeys can be any valid string, but must be unique for every request.\nFor more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).\n\nThe minimum length is 1 and the maximum length is 45."
},
"team_member": {
"type": "object",
"description": "A record representing an individual team member for a business.",
"properties": {
"assigned_locations": {
"type": "object",
"description": "An object that represents a team member's assignment to locations.",
"properties": {
"assignment_type": {
"type": "string",
"description": "The current assignment type of the team member."
},
"location_ids": {
"type": "array",
"description": "The locations that the team member is assigned to.",
"items": {
"type": "string"
}
}
}
},
"created_at": {
"type": "string",
"description": "The timestamp, in RFC 3339 format, describing when the team member was created.\nFor example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\"."
},
"email_address": {
"type": "string",
"description": "The email address associated with the team member."
},
"family_name": {
"type": "string",
"description": "The family name (that is, the last name) associated with the team member."
},
"given_name": {
"type": "string",
"description": "The given name (that is, the first name) associated with the team member."
},
"id": {
"type": "string",
"description": "The unique ID for the team member."
},
"is_owner": {
"type": "boolean",
"description": "Whether the team member is the owner of the Square account."
},
"phone_number": {
"type": "string",
"description": "The team member's phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR"
},
"reference_id": {
"type": "string",
"description": "A second ID used to associate the team member with an entity in another system."
},
"status": {
"type": "string",
"description": "Describes the status of the team member."
},
"updated_at": {
"type": "string",
"description": "The timestamp, in RFC 3339 format, describing when the team member was last updated.\nFor example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\"."
}
}
}
}
}{
"type": "object",
"description": "Represents a response from a create request containing the created `TeamMember` object or error messages.",
"properties": {
"errors": {
"type": "array",
"description": "The errors that occurred during the request.",
"items": {
"type": "object",
"description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"description": "The high-level category for the error."
},
"code": {
"type": "string",
"description": "The specific code of the error."
},
"detail": {
"type": "string",
"description": "A human-readable description of the error for debugging purposes."
},
"field": {
"type": "string",
"description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
}
}
}
},
"team_member": {
"type": "object",
"description": "A record representing an individual team member for a business.",
"properties": {
"assigned_locations": {
"type": "object",
"description": "An object that represents a team member's assignment to locations.",
"properties": {
"assignment_type": {
"type": "string",
"description": "The current assignment type of the team member."
},
"location_ids": {
"type": "array",
"description": "The locations that the team member is assigned to.",
"items": {
"type": "string"
}
}
}
},
"created_at": {
"type": "string",
"description": "The timestamp, in RFC 3339 format, describing when the team member was created.\nFor example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\"."
},
"email_address": {
"type": "string",
"description": "The email address associated with the team member."
},
"family_name": {
"type": "string",
"description": "The family name (that is, the last name) associated with the team member."
},
"given_name": {
"type": "string",
"description": "The given name (that is, the first name) associated with the team member."
},
"id": {
"type": "string",
"description": "The unique ID for the team member."
},
"is_owner": {
"type": "boolean",
"description": "Whether the team member is the owner of the Square account."
},
"phone_number": {
"type": "string",
"description": "The team member's phone number, in E.164 format. For example:\n+14155552671 - the country code is 1 for US\n+551155256325 - the country code is 55 for BR"
},
"reference_id": {
"type": "string",
"description": "A second ID used to associate the team member with an entity in another system."
},
"status": {
"type": "string",
"description": "Describes the status of the team member."
},
"updated_at": {
"type": "string",
"description": "The timestamp, in RFC 3339 format, describing when the team member was last updated.\nFor example, \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\"."
}
}
}
}
}