{"id":5012,"date":"2025-02-05T13:25:22","date_gmt":"2025-02-05T19:25:22","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5012"},"modified":"2025-02-05T13:27:42","modified_gmt":"2025-02-05T19:27:42","slug":"adding-a-user","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/user-apis\/adding-a-user\/","title":{"rendered":"Adding a User"},"content":{"rendered":"

Requires FaxFinder 3.0.4 or higher.<\/em><\/p>\n\n\n\n\n\n
\n

HTTP Request Line<\/p>\n<\/td>\n

\n

POST \/ffws\/v1\/users HTTP\/1.1<\/p>\n<\/td>\n<\/tr>\n

\n

HTTP Response Status Codes<\/p>\n<\/td>\n

\n

200 OK<\/p>\n<\/td>\n

\n

Created user.<\/p>\n<\/td>\n<\/tr>\n

\n

403 Forbidden<\/p>\n<\/td>\n

\n

Authenticated user does not have permission to add users.<\/p>\n<\/td>\n<\/tr>\n<\/tr>\n

\n

400 Bad Request<\/p>\n<\/td>\n

\n

The provided XML is not valid.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

Example<\/h4>\n
\r\nPOST \/ffws\/v1\/users HTTP\/1.1\r\ncontent-type: application\/xml\r\nauthorization: Basic YWRtaW46YWRtaW4=\r\n<?xml version=\u201d1.0\u201d encoding=\u201dUTF-8\u201d?>\r\n<user>\r\n\t<name>New User 1<\/name>\r\n\t<username>user1<\/username>\r\n\t<password>user1<\/password>\r\n\t<email_address>admin@Example.com<\/email_address>\r\n\t<phone_number>218-555-3333<\/phone_number>\r\n\t<fax_number>218-555-3334<\/fax_number>\r\n\t<organization>Example Org<\/organization>\r\n\t<priority>1<\/priority>\r\n\t<max_attempts>2<\/max_attempts>\r\n\t<interval>600<\/interval>\r\n\t<receipt>never<\/receipt>\r\n\t<receipt_attachment>none<\/receipt_attachment>\r\n<\/user>\r\n-----------------------------------\r\n<?xml version=\u201d1.0\u201d encoding=\u201dUTF-8\u201d?>\r\n<response>\r\n\t<message>Created<\/message>\r\n\t<user>\r\n\t\t<user_url>https:\/\/172.16.0.3\/ffws\/v1\/users\/user1<\/user_url>\r\n\t\t<name>New User 1<\/name>\r\n\t\t<username>user1<\/username>\r\n\t\t<email_address>admin@Example.com<\/email_address>\r\n\t\t<phone_number>218-555-3333<\/phone_number>\r\n\t\t<fax_number>218-555-3334<\/fax_number>\r\n\t\t<organization>Example Org<\/organization>\r\n\t\t<default_cover_page_enabled>false<\/default_cover_page_enabled>\r\n\t\t<default_cover_page_name><\/default_cover_page_name>\r\n\t\t<priority>1<\/priority>\r\n\t\t<max_attempts>2<\/max_attempts>\r\n\t\t<interval>600<\/interval>\r\n\t\t<receipt>never<\/receipt>\r\n\t\t<receipt_attachment>none<\/receipt_attachment>\r\n\t<\/user>\r\n<\/response>\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Requires FaxFinder 3.0.4 or higher. HTTP Request Line POST \/ffws\/v1\/users HTTP\/1.1 HTTP Response Status Codes 200 OK Created user. 403 Forbidden Authenticated user does not have permission to add users. 400 Bad Request The provided XML is not valid. Example POST \/ffws\/v1\/users HTTP\/1.1 content-type: application\/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=\u201d1.0\u201d encoding=\u201dUTF-8\u201d?> <user> <name>New User 1<\/name> […]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5405,"menu_order":23,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-5012","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5012","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/537"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=5012"}],"version-history":[{"count":16,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5012\/revisions"}],"predecessor-version":[{"id":5668,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5012\/revisions\/5668"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5405"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5012"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}