Add a user to the list of members for this account.
/accounts/{account_identifier}/members
post
Account Members
account-members-add-member
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#organization:edit"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"description": "The contact email address of the user.",
"example": "user@example.com",
"maxLength": 90,
"type": "string"
},
"roles": {
"description": "Array of roles associated with this member.",
"items": {
"description": "Role identifier tag.",
"example": "3536bcfad5faccb999b47003c79917fb",
"maxLength": 32,
"type": "string"
},
"type": "array"
},
"status": {
"default": "pending",
"enum": [
"accepted",
"pending"
]
}
},
"required": [
"email",
"roles"
],
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"id": {
"description": "Membership identifier tag.",
"example": "4536bcfad5faccb111b47003c79917fa",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"roles": {
"description": "Roles assigned to this member.",
"items": {
"properties": {
"description": {
"description": "Description of role's permissions.",
"example": "Administrative access to the entire Account",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Role identifier tag.",
"example": "3536bcfad5faccb999b47003c79917fb",
"maxLength": 32,
"type": "string"
},
"name": {
"description": "Role name.",
"example": "Account Administrator",
"maxLength": 120,
"readOnly": true,
"type": "string"
},
"permissions": {
"allOf": [
{
"example": {
"analytics": {
"read": true,
"write": false
},
"zones": {
"read": true,
"write": true
}
},
"properties": {
"analytics": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"billing": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"cache_purge": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"dns": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"dns_records": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"lb": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"logs": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"organization": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"ssl": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"waf": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"zone_settings": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"zones": {
"example": {
"read": true,
"write": false
},
"properties": {
"read": {
"example": true,
"type": "boolean"
},
"write": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
{
"readOnly": true
}
]
}
},
"required": [
"id",
"name",
"description",
"permissions"
],
"type": "object"
},
"type": "array"
},
"status": {
"readOnly": true
},
"user": {
"properties": {
"email": {
"description": "The contact email address of the user.",
"example": "user@example.com",
"maxLength": 90,
"type": "string"
},
"first_name": {
"description": "User's first name",
"example": "John",
"maxLength": 60,
"nullable": true,
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"last_name": {
"description": "User's last name",
"example": "Appleseed",
"maxLength": 60,
"nullable": true,
"type": "string"
},
"two_factor_authentication_enabled": {
"default": false,
"description": "Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.",
"readOnly": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"email"
],
"type": "object"
}
},
"required": [
"id",
"user",
"status",
"roles"
],
"type": "object"
},
{
"properties": {
"code": {
"description": "The unique activation code for the account membership.",
"example": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
"maxLength": 64,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
]
}
},
"type": "object"
}
]
}
}
},
"description": "Add Member response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Add Member response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]